https://github.com/robinnaumann/elbe_react

https://github.com/robinnaumann/elbe_react

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/robinnaumann/elbe_react
• Owner: RobinNaumann
• Created: 2024-09-06T18:25:28.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-06T18:25:30.000Z (4 months ago)
• Last Synced: 2024-11-14T11:23:13.173Z (about 2 months ago)
• Language: TypeScript
• Size: 38.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# elbe

a cross platform UI framework for the web and Flutter [(see this package)](https://pub.dev/packages/elbe)

so far, it has been optimized for React. It provides a variety of Widgets and theming options. Check out [the demo](https://robbb.in/elbe) or the example within this package (`./example`)

## usage

1. install the package in your React/Preact app:

   ```bash

   npm i elbe-ui

   ```

2. add the styles to your main `.scss`/`.sass` file:

   ```scss

   @use "elbe-ui/elbe.scss" with (

     $c-accent: #448aff,

     //$g-radius: 0,

     //$t-font-body: "Comic Sans MS",

     //...

   );

   ```

3. add class `primary` to your page `body` element


   (`...`)

4. start using the components :)

# contribute

as of now, this is mainly a personal project for different stuff I built. So things might be a little rough around the edges. If you find any issues or want to help make elbe better, I'd love to hear from you :)

## publish

1. increment `version` number in `package.json`

2. run `bun run build`

3. run `npm publish`