Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/docs #12

Merged
merged 4 commits into from
Sep 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
. "$(dirname -- "$0")/_/husky.sh"
npx commitlint --edit $1
1 change: 0 additions & 1 deletion .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
. "$(dirname -- "$0")/_/husky.sh"
npm run build
5 changes: 5 additions & 0 deletions lib/components/Button/Button.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ export const Primary: Story = {
args: {
label: 'Button',
bgColor: '#2b8164',
textColor: '#ffffff',
type: 'button',
size: 'md',
isOutline: false,
onClick: () => console.log('Button clicked'),
} as ButtonProps,
render: (args) => <Button {...args} />,
}
File renamed without changes.
19 changes: 19 additions & 0 deletions lib/components/Main/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Main Layout Component

The `<main>` tag represents the main content area of a document. The content inside the <main> tag should be unique to the document and should not contain other global elements such as navigation, asides, footers and more. There should be no more than one <main> tag used in a document.

## Props

The following props are available on the `Main` component:

- `children` - accepts children elements
- `maxWidth` - sets a max width class that applies to direct descendants
- `noProse` - removes the automatically applied Tailwind prose classes

## Example

```jsx
<Main maxWidth="5xl">
<p>Add content elements here</p>
</Main>
```
2 changes: 1 addition & 1 deletion lib/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
@import 'tailwindcss/utilities';

/* Global Classes */
@import './styles/button-links.css';
@import './components/Button/styles.css';
@import './styles/max-width.css';
9,959 changes: 4,263 additions & 5,696 deletions package-lock.json

Large diffs are not rendered by default.

52 changes: 26 additions & 26 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"build:storybook": "storybook build",
"prettier": "prettier --write .",
"size": "size-limit",
"rebuild": "rm -rf node_modules ; rm package-lock.json ; npm install",
"clean": "rm -rf node_modules ; rm package-lock.json ; npm install",
"test": "echo \"No test specified\" && exit 0",
"prepare": "husky"
},
Expand All @@ -49,39 +49,39 @@
"react-dom": "^18.3.1"
},
"devDependencies": {
"@commitlint/cli": "^19.3.0",
"@commitlint/config-conventional": "^19.2.2",
"@commitlint/cli": "^19.4.1",
"@commitlint/config-conventional": "^19.4.1",
"@size-limit/preset-big-lib": "^11.1.4",
"@storybook/addon-a11y": "^8.1.1",
"@storybook/addon-essentials": "^8.1.1",
"@storybook/addon-interactions": "^8.1.1",
"@storybook/addon-links": "^8.1.1",
"@storybook/addon-onboarding": "^8.1.1",
"@storybook/addon-a11y": "^8.2.9",
"@storybook/addon-essentials": "^8.2.9",
"@storybook/addon-interactions": "^8.2.9",
"@storybook/addon-links": "^8.2.9",
"@storybook/addon-onboarding": "^8.2.9",
"@storybook/addon-styling": "^1.3.7",
"@storybook/blocks": "^8.1.1",
"@storybook/react": "^8.1.1",
"@storybook/react-vite": "^8.1.1",
"@storybook/blocks": "^8.2.9",
"@storybook/react": "^8.2.9",
"@storybook/react-vite": "^8.2.9",
"@storybook/testing-library": "^0.2.2",
"@types/react": "^18.3.2",
"@types/react": "^18.3.5",
"@types/react-dom": "^18.3.0",
"@typescript-eslint/eslint-plugin": "^7.9.0",
"@typescript-eslint/parser": "^7.9.0",
"@vitejs/plugin-react": "^4.2.1",
"autoprefixer": "^10.4.19",
"@typescript-eslint/eslint-plugin": "^8.4.0",
"@typescript-eslint/parser": "^8.4.0",
"@vitejs/plugin-react": "^4.3.1",
"autoprefixer": "^10.4.20",
"eslint": "^8.57.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-prettier": "^5.1.3",
"eslint-plugin-prettier": "^5.2.1",
"eslint-plugin-react-hooks": "^4.6.2",
"eslint-plugin-react-refresh": "^0.4.7",
"eslint-plugin-react-refresh": "^0.4.11",
"eslint-plugin-storybook": "^0.8.0",
"husky": "^9.0.11",
"postcss": "^8.4.38",
"prettier": "^3.2.5",
"husky": "^9.1.5",
"postcss": "^8.4.45",
"prettier": "^3.3.3",
"size-limit": "^11.1.4",
"storybook": "^8.1.1",
"tailwindcss": "^3.4.3",
"typescript": "^5.4.5",
"vite": "^5.2.11",
"vite-plugin-dts": "^3.9.1"
"storybook": "^8.2.9",
"tailwindcss": "^3.4.10",
"typescript": "^5.5.4",
"vite": "^5.4.3",
"vite-plugin-dts": "^4.1.1"
}
}
Loading