https://github.com/kleros/ui-components-library

UI components library which implements the Kleros design system.
https://github.com/kleros/ui-components-library

frontend kleros kleros-v2 react-component-library ui-components

Last synced: about 1 month ago
JSON representation

UI components library which implements the Kleros design system.

• Host: GitHub
• URL: https://github.com/kleros/ui-components-library
• Owner: kleros
• License: mit
• Created: 2021-12-03T11:04:20.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-16T10:38:24.000Z (about 1 month ago)
• Last Synced: 2024-12-16T11:35:41.315Z (about 1 month ago)
• Topics: frontend, kleros, kleros-v2, react-component-library, ui-components
• Language: TypeScript
• Homepage: https://www.figma.com/file/b7DEUKDeHlOl4ocDTMv7UIhZ/Kleros?node-id=7515%3A9807
• Size: 1.63 MB
• Stars: 7
• Watchers: 7
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  



Kleros UI Components Library




  

  

  



## Introduction

## Usage

#### Install the package

With `yarn add @kleros/ui-components-library` or `npm install @kleros/ui-components-library`

#### Create a theme file

Wwhere you destructure `lightTheme` or `darkTheme` (or both) in your theme object to provide the correct colors to the components. ([example](https://github.com/kleros/kleros-v2/blob/dev/web/src/styles/themes.ts)).

#### Provide the theme

With styled-components `ThemeProvider` ([example](https://github.com/kleros/kleros-v2/blob/dev/web/src/context/StyledComponentsProvider.tsx)).

## Package Publication 

#### Tagging

1. Bump the version in `package.json`

1. Run a clean build: `yarn clean && yarn build`

1. Commit the change to git: `git add -u ; git commit -m "chore: release"`

1. Tag this version: `version=v$(cat package.json | jq -r .version) && git tag -m $version $version`

1. Push both commit and tag: `git push && git push --tags`

#### Publish to NPM

1. Export your NPM token: ` export YARN_NPM_AUTH_TOKEN=`

1. Publish: `yarn publish`

#### Publish to Github

1. Login 

```bash

npm login --registry https://npm.pkg.github.com --auth-type legacy

> Username: YOUR_GITHUB_USERNAME

> Password: YOUR_GITHUB_PERSONAL_ACCESS_TOKEN`

```

2. Publish: `npm publish --registry https://npm.pkg.github.com`