Skip to content
This repository has been archived by the owner on Aug 5, 2022. It is now read-only.

xstevenyung/guillotin-solid-v1

Repository files navigation

Deprecation: Due to lack of time, this package is now deprecated.

Guillotin

Collection of Headless Components for demanding developers

Full documentation

What is Guillotin?

Guillotin (named after Joseph-Ignace Guillotin) is a headless components library for demanding developers who needs complete control over the UI of their app without re-inventing the wheel and giving up on productivity.

This library is lightweight, and ultra-customizable, but do not render any markup or styles for you. This effectively means that Guillotin is a "headless" UI library

What is a "headless" UI library?

React Headless Notifier is a headless utility, which means out of the box, it doesn't render or supply any actual UI elements. You are in charge of utilizing styling and managing your different notification types across your application. Read this article to understand why Guillotin is built this way. If you don't want to, then here's a quick explanation of why headless UI is important:

  • Separation of Concerns - Not that superficial kind you read about all the time. The real kind. React Headless Notifier as a library honestly has no business being in charge of your UI. The look, feel, and overall experience of your table is what makes your app or product great. The less React Headless Notifier gets in the way of that, the better!
  • Maintenance - By removing the API surface area required to support every UI use-case, React Headless Notifier can remain small, easy-to-use and simple to customize.
  • Extensibility - UI presents countless edge cases for a library simply because it's a creative medium, and one where every developer does things differently. By not dictating UI concerns, React Headless Notifier empowers the developer to design and extend the UI based on their unique use-case.

Getting Started

Installation

npm install --save @guillotin/solid

or

yarn add @guilltoin/solid

Guillotin is compatible with Solid.js v1.0.0+.

Choose a component and use it

At the moment, Guillotin only include 2 components, Toaster and Modal. We are working on increasing the size of the library. If you have any suggestions of what component we could add, feel free to open an issue.

Full documentation