@kieranproctor/kui v1.2.0

@kieranproctor/kui

@kieranproctor/kui is a ReactJS component library styled using Tailwind CSS.

Components

- Breadcrumbs
- Button

Installation

1. Firstly create a project using npx creacte-react-app or another tool.

2. Install the library: yarn add @kieranproctor/kui // or npm install @kieranproctor/kui

3. Configure tailwind.config.js.

const withConfig = require("@kieranproctor/utils/withConfig");

module.exports = withConfig({
  content: ["./src/**/*.{js,jsx,ts,tsx}"],
  theme: {
    extend: {},
  },
  plugins: [],
});

4. Develop away, have fun 😀.

Theme Provider

@kieranproctor/kui comes with a theme provider which you can use to provide a custom theme. To get started simply wrap the application with the ThemeProdiver provided.

import React from "react";
import ReactDOM from "react-dom/client";
import App from "App";
import { ThemeProvider } from "@kieranproctor/kui";

const root = createRoot(document.getElementById("root"));

root.render(
  <ThemeProvider>
    <App />
  </ThemeProvider>,
);

Usage/Examples

Below is a snippet of how to use one of the components in your app.

import React from 'react';
import { Button } from '@kieranproctor/kui';

function App() {
  return <Button colour="blue">Click me 😀</Button>
}

If you need more, why not try out the demo project here?

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project's CODE_OF_CONDUCT.md.

Authors

• @Kieran