@binarycapsule/ui-capsules

UI kit

Usage no npm install needed!

<script type="module">
  import binarycapsuleUiCapsules from 'https://cdn.skypack.dev/@binarycapsule/ui-capsules';
</script>

README

BC logo

UI-Capsules - React UI Kit 👷‍♂💊🚧 wip️

build status npm link netlify badge

React UI kit.

🚨 Breakable toy 🚨

This library is a breakable toy. New versions will often contain breaking changes, even for non-major releases.

The Components demo (wip) can be visited here.

UIC light mode UIC dark mode

Install

UI-Capsules is available at npm. To add it to your app run:

npm i @binarycapsule/ui-capsules

The following peer dependencies should also be installed:

npm i react react-dom @stitches/react

Setup

Import the setup script at the entry point of you app:

import '@binarycapsule/ui-capsules/dist/setup';

Render the ToastContainer:

import { ToastContainer } from '@binarycapsule/ui-capsules';

ReactDOM.render(
  <React.StrictMode>
    <App />

    <ToastContainer />
  </React.StrictMode>,
  document.getElementById('root'),
);

Render the useGlobalStyles hook:

import { useGlobalStyles } from '@binarycapsule/ui-capsules';

function App() {
  useGlobalStyles();

  return (
    <div>
      ...
    </div>
  );
}

Usage

Please refer to the Components demo to get further instructions on how to use each component.

Licensing

Licensed under the MIT License.