diff --git a/.changeset/shiny-kangaroos-search.md b/.changeset/shiny-kangaroos-search.md new file mode 100644 index 0000000..44b9f82 --- /dev/null +++ b/.changeset/shiny-kangaroos-search.md @@ -0,0 +1,5 @@ +--- +'@miksoft/simple-uikit': patch +--- + +Added descriptions for Container Props UI Component diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index e235461..acc1f6c 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -82,20 +82,7 @@ jobs: node-version: 20 cache: 'npm' - - name: Cache node modules - uses: actions/cache@v4 - id: cache-npm-storybook - with: - path: | - node_modules - ~/.npm - key: ${{ runner.os }}-storybook-modules-${{ hashFiles('yarn.lock') }} - restore-keys: | - ${{ runner.os }}-storybook-modules- - ${{ runner.os }}- - - - if: ${{ steps.cache-npm-storybook.outputs.cache-hit != 'true' }} - name: Install dependencies for Storybook + - name: Install dependencies for Storybook working-directory: storybook run: npm install diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index b73d485..113f6a9 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -33,7 +33,9 @@ jobs: run: yarn build - name: Create .npmrc - run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc + run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }} + //npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }} + @miksrv:registry=https://npm.pkg.github.com/" > ~/.npmrc - name: Create Release Pull Request or Publish to npm id: changesets @@ -43,3 +45,8 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + + - name: Publish to GitHub Packages + run: npm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/package.json b/package.json index cb94b68..08dd485 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,8 @@ "prettier:fix": "prettier --write ." }, "publishConfig": { - "access": "public" + "access": "public", + "registry": "https://npm.pkg.github.com/" }, "access": "public", "main": "dist/index.js", diff --git a/src/container/Container.tsx b/src/container/Container.tsx index 050e954..c96f2d9 100644 --- a/src/container/Container.tsx +++ b/src/container/Container.tsx @@ -4,12 +4,21 @@ import styles from './styles.module.sass' import { concatClassNames as cn } from '@/tools' +/** + * Interface for the properties of a container component. + */ export interface ContainerProps extends React.HTMLAttributes { + /** The title of the container. Displayed at the top of the container */ title?: string + /** Additional class names to apply to the container */ className?: string + /** An action element, typically a button or link, displayed in the container header */ action?: React.ReactNode + /** Custom header content for the container */ header?: React.ReactNode + /** The content of the container */ children?: React.ReactNode + /** Custom footer content for the container */ footer?: React.ReactNode }