probica15 v0.2.9
Faxi-Kinto web component library
Intro
Before you is a React component library based on the components used in the Create a Community - Kinto-Join app.
The package is generated using rollup.
- Run
npm buildto build the package. - Run
npm startto run the package in watch mode.
Transpiled files are located in the /build folder.
You can access demo/storybooks here.
Install
npm i @faxi/web-component-libraryUsage
import React from 'react';
import { Button } from '@faxi/web-component-library';
const MyClass: React.FC = (): JSX.Element => {
render() {
return <Button />;
}
}The package knows its types, meaning that IntelliSense aids you when using package's components and shows all of the possible props and their definitions.
Dependecies
This package depends on the @fortawesome/pro-solid-svg-icons which requires an authToken.
Add Your token in an .npmrc file in the root of Your project.
Tests
Every component is provided with its test file. Run npm run test within the package to run tests.
Storybook
Every component can be previewed (in isolation) within the Storybook UI.
Run npm run storybook to build the storybook.
License
MIT ©