/components

Lapidist's design system with an opinionated set of React components, powered by @lapidist/styles and TypeScript.

Primary LanguageTypeScriptMIT LicenseMIT

Lapidist Logo

@lapidist/components

Opinionated React UI library, built with @lapidist/styles and TypeScript.

npm bundle size (scoped) npm GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch) codecov Maintainability Node GitHub Issues GitHub Build Status

Getting Started

@lapidist/components is available as an npm package.

See https://components.lapidist.net for the full documentation.

Installation

npm install @lapidist/components

Usage

Ensure you wrap your application with the <ThemeProvider> component. Here is a quick example to get you started:

import React from 'react';
import { createRoot } from 'react-dom/client';
import { ThemeProvider, Text } from '@lapidist/components';
import '@lapidist/components/style.css';

const App = () => (
    <ThemeProvider>
        <Text>Hello world</Text>
    </ThemeProvider>
);

const root = createRoot(document.querySelector('#app'));
root.render(<App />);

Philosophy

  • Quality over quantity: a small library of well-designed components is preferable to many poor components.
  • Constraints are good: consistency takes precedence over configurability.
  • Modern: we don't support older browsers.

License

@lapidist/components is licensed under the MIT license. See LICENSE for the full text.