syrup-ui

SweetScript/Syrup-UI

A pleasant React UI library based on TailwindCSS

[ Early phase, still UNDER DEVELOPMENT]

---

Dependencies

• React ^18.2.0
• TailwindCSS: ^3.1.6
• dayjs: ^1.11.7
• @react-spring/web: ^9.5.4
• react-use-measure: ^2.1.1
• cleave.js: ^1.6.0
• @use-gesture/react: ^10.2.20

---

Installation

1. Install library

npm i syrup-ui

1. Add tailwind preset: in your tailwind.config.js file add the following preset:

presets: [
    require('./node_modules/syrup-ui/tailwind-preset.js') //Add this line to the presets property
]

1. Import CSS styles: in your main css file add the following import line:

@import "~syrup-ui/styles/styles.css";

1. Wrap your app with the ThemeProvider

import {ThemeProvider} from 'syrup-ui';

<ThemeProvider>
    <Component {...pageProps} />
</ThemeProvider>

Customization

Documentation Soon

Contact

majid@sweetscript.com