KEEP REACT
Keep React is an open-source component library built on Tailwind CSS and React.js. It provides a versatile set of pre-designed UI components that enable developers to streamline the creation of modern, responsive, and visually appealing web applications.
Table of Contents
Installation
Vite React Application
Setting Up Keep React in Vite React Application
Step 1: Create a Vite React Application
npm create vite@latest my-project -- --template react
cd my-projectStep 2: Install Tailwind CSS
npm i autoprefixer postcss tailwindcss
npx tailwindcss init -pStep 3: Install Keep React:
npm i keep-react phosphor-reactOr with Yarn
yarn add keep-react phosphor-reactOr with Pnpm
pnpm add keep-react phosphor-reactStep 4: Go to the tailwind.config.js file and paste the
following code:
import keepPreset from 'keep-react/preset'
export default {
content: ['./index.html', './src/**/*.{js,ts,jsx,tsx}', 'node_modules/keep-react/**/*.{js,jsx,ts,tsx}'],
presets: [keepPreset],
}Step 5: Add Tailwind CSS to index.css File:
@import 'keep-react/css';
@tailwind base;
@tailwind components;
@tailwind utilities;Next JS Application
You can easily integrate keep-react into your Next.js application.
Step 1: Install Next Js Application
npx create-next-app@latestEnsure that you select tailwindcss as a dependency for your application during the setup.
Would you like to use Tailwind CSS? -- Yes
Step 2: Install Keep React
npm i keep-react phosphor-reactOr with Yarn
yarn add keep-react phosphor-reactOr with Pnpm
pnpm add keep-react phosphor-reactStep 3: Go to the tailwind.config.js file and paste the
following code
module.exports = {
content: [
// ... (existing content)
'./node_modules/keep-react/**/*.{js,jsx,ts,tsx}',
],
presets: [require('keep-react/preset')],
}Step 4: Add Tailwind CSS to globals.css File:
@import 'keep-react/css';
@tailwind base;
@tailwind components;
@tailwind utilities;Congratulations! You have successfully installed the Keep React. Now you can import any component from keep-react and use it in your project.
usage
'use client'
import { Button } from 'keep-react'
const App = () => {
return <Button>Button</Button>
}
export default AppComponents
The Keep React offers a wide range of components to build your user interfaces. For detailed usage and examples of each component, refer to our component documentation.
Contributing
If you want to contribute to the Keep React, you can follow the contributing guide.
Contributors
This project exists thanks to all the people who contribute:
Figma
If you need access to Figma design files for the components, you can check out our website for more information:
Get access to the Figma design files
License
The Keep-React name and logos are trademarks of StaticMania.