@creation-ui/core
v0.6.0
Published
@creation-ui/core is a core package for components library in Creation UI family.
Downloads
248
Maintainers
Readme
Creation UI
is a design system that lets you build a React powered websites and apps. It's built on top of Tailwind CSS and currently supports React and Solid.
A great starting point for your next project.
Prerequisites
Creation UI is working with your app's Tailwind CSS and you need to have Tailwind CSS installed in your project - Tailwind CSS Installation.
"peerDependencies": {
"tailwindcss": "^3.0"
},
Installation
To install the core packages of Creation UI, run command below:
yarn add @creation-ui/core
npm i @creation-ui/core
pnpm i @creation-ui/core
Configuration
- Add
withTailwindConfig
to yourtailwind.config.js
file:
const withTailwindConfig = require('@creation-ui/react/utils/withTailwindConfig')
module.exports = withTailwindConfig({
content: ['./**/*.{js,ts,jsx,tsx,mdx}', '*.css'],
})
You can extend all properties as usual.
- Import library's CSS file into your app.
If you're using standard config of
Next.js
, you should import it inpages/_app.js
or similar. If you're using standard config ofcreate-react-app
orVite
, you should import it inindex.js
or similar.
import '@creation-ui/core/index.css'
- Start using it!
If you are using either React or Solid you can add components by installing their respective packages:
React
yarn add @creation-ui/react
npm i @creation-ui/react
pnpm i @creation-ui/react
import { Button } from '@creation-ui/react'
export default function App() {
return <Button>Click me</Button>
}
Solid
yarn add @creation-ui/solid
npm i @creation-ui/solid
pnpm i @creation-ui/solid
import { Button } from '@creation-ui/solid'
export default function App() {
return <Button>Click me</Button>
}