|
|
||
|---|---|---|
| .. | ||
| public | ||
| src | ||
| .eslintrc.js | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.cjs | ||
| histoire.config.ts | ||
| histoire.setup.ts | ||
| package.json | ||
| postcss.config.cjs | ||
| README.md | ||
| tailwind.config.ts | ||
| tsconfig.json | ||
| ui-preset.ts | ||
| vite.config.ts | ||
Hoppscotch UI ALPHA
Welcome to hoppscotch-ui, a collection of presentational components for our web applications. This library is part of the hoppscotch monorepo and contains components such as buttons, spinners, modals, tabs, windows, etc.
Usage
To use the components in project, simply name the component with directory name as alias:
For example Primary Button component is in button directory and the file name is Primary.vue. So, use that you have to write <HoppButtonPrimary />
Histoire
We've included Histoire in this library which is similar to Storybook, to make it easy to play with the components in the browser. You can run Histoire in the browser with command
pnpm run story:dev
You can also use Histoire to create stories for your components and test them in different scenarios.
Versioning
This project follows Semantic Versioning but as the project is still pre-1.0. The code and the public exposed API should not be considered to be fixed and stable. Things can change at any time!
License
This project is licensed under the MIT License - see LICENSE for more details.