https://github.com/threshold-network/components
React components for Threshold Network.
https://github.com/threshold-network/components
Last synced: 7 months ago
JSON representation
React components for Threshold Network.
- Host: GitHub
- URL: https://github.com/threshold-network/components
- Owner: threshold-network
- Created: 2022-04-12T07:53:37.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T09:40:37.000Z (over 2 years ago)
- Last Synced: 2025-05-30T00:07:50.940Z (about 1 year ago)
- Language: TypeScript
- Size: 607 KB
- Stars: 2
- Watchers: 14
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Threshold Network React Components
This repo contains reusable React components for Threshold Network.
_For design documentation on these components, refer to the repo on Design
System documentation
[here](https://github.com/threshold-network/design-system-docs)._
_You can also duplicate the Figma file
[here](https://www.figma.com/file/zZi2fYDUjWEMPQJWAt8VWv/Threshold-DS?node-id=3436%3A24296)._
## Setup
---
### Install packages
`yarn`
### Run storybook
`yarn run storybook`
## Use package locally in different project
---
### Build the project
`yarn build` - this should build the code inside a `lib` directory
### Create compressed gzip archive of package dependencies
To use the package locally without uploading it to npm registry you can:
`yarn pack --filename ` - which will create a gzip archive (with the name given after `-- namefile`) of the
package in the root directory
### Use the gzip archive in your project
To use the created gzip archive in your project you should go to your project directory and run:
```
yarn add file:.tgz
```
Alternatively you can just add the file to the project's `package.json` by adding this line there:
`"@threshold-network/components": "file:.//.tgz",`
and after that you just run:
`yarn`
### You can now use your local package in your project
You can now use the local version of threshold network components by simply importing them from
`@threshold-network.components`. For
example:
`import { H1 } from "@threshold-network/components"`
#### Note
After executing `yarn pack` yarn caches the package so any changes made will not be saved after re-doing `yarn pack`
until you clean the yarn cache (`yarn cache clean`) or just change the name of the packed file specified in `--filename`
argument.