tailwindcss-h2o-components
v0.1.22
Published
This is a library of components by H20 Innovation. This can be used in all of front-end projects of enterprise.
Downloads
18
Readme
H2O Innovation | Components with TailwindCSS
This is a library of components by H20 Innovation. This can be used in all of front-end projects of enterprise.
In this library, we use Typescript, and if you're new to Typescript and React, checkout this handy cheatsheet.
Components available
This component lilbrary is under dev, then, will be add some news components in future.
Inputs
- Input Fieldset
Buttons
- Action Button
- Primary
- Icon
- Secondary
- Icon
- Primary
- Action Button with Loading
- Primary
- Icon
- Secondary
- Icon
- Primary
Layouts
- Modal
- Slide Over
Commands
The recommended workflow if to run this project in one terminal:
npm start # or yarn start
This builds to /dist
and runs the project in watch mode so any edits you save inside src
causes a rebuild to /dist
.
Storybook
Run inside another terminal:
yarn storybook
This loads the stories from ./stories
.
NOTE: Stories should reference the components as if using the library, similar to the example playground. This means importing from the root project directory. This has been aliased in the tsconfig and the storybook webpack config as a helper.
Example
Then run the example inside another:
cd example
npm i # or yarn to install dependencies
npm start # or yarn start
The default example imports and live reloads whatever is in /dist
, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. No symlinking required, we use Parcel's aliasing.
To do a one-off build, use npm run build
or yarn build
.
To run tests, use npm test
or yarn test
.
Configuration
Code quality is set up for you with prettier
, husky
, and lint-staged
. Adjust the respective fields in package.json
accordingly.
Rollup
TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details. Você vai ficar me olhando pora? Qual que foi, tá me querendo? t
TypeScript
tsconfig.json
is set up to interpret dom
and esnext
types, as well as react
for jsx
. Adjust according to your needs.
Deploying the Example Playground
The Playground is just a simple Parcel app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for manually deploying with the Netlify CLI (npm i -g netlify-cli
):
cd example # if not already in the example folder
npm run build # builds to dist
netlify deploy # deploy the dist folder
Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
netlify init
# build command: yarn build && cd example && yarn && yarn build
# directory to deploy: example/dist
# pick yes for netlify.toml