@satori-sdk/component-library
v0.1.11
Published
React component library used for Satori apps
Downloads
4
Readme
Satori Component Library
This is a React component library used by Satori apps. The following components are included in this library:
- AvatarPicker: component for displaying avatars and picker component for choosing name/avatar combo
- CopyButton: Copy button component
- Mini Web Console: a mini Satori console for displaying RTM messages
- Share: component for sharing links or other texts. When clicked, display an overlay containing the CopyButton
- GitHubButton - component for Go to GitHub repo button.
- SignUpButton - component for Sign Up button for satori dev portal.
- SatoriLogo - component for Satori logo image.
- AppShell - component for app shell with common styles.
- AppHeader - component for app header with Logo, GitHub and SignUp buttons.
Getting Started
To run locally:
- clone the repo
yarn install
&&npm run storybook
To use the components:
- install:
npm i @satori-sdk/component-library
- import modules to use:
import { CopyButton, AvatarPicker } from '@satori-sdk/component-library';
- follow examples in storybook
To publish package:
npm login
using satori-sdk usernpm run publish-<version>
where <version> can be major, minor or patch.