Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 1.6 KB

README.md

File metadata and controls

59 lines (40 loc) · 1.6 KB
Raw

Solid UI

This library contains a suite of themeable UI components written for the SolidJS Lightning Framework. check them out in our storybook docs.

npm version

Getting Started

If you haven't already, follow the steps found here to bootstrap your SolidJS Lightning app. Then:

  1. install this package and the base theme with your package manager of choice
pnpm add @lightningtv/solid-ui @lightningtv/l3-ui-theme-base # or npm/yarn
  1. add the theme package as an alias in your vite config(see the theming docs for more information on this)
// vite.config.js
  resolve: {
    alias: {
      theme: '@lightningtv/l3-ui-theme-base',
    }
  },
  1. and finally, use a component
// App.jsx
import { Button } from '@lightningtv/solid-ui';
<App>
  <Button>a button!</Button>
</App>;

Reporting a Bug

If you come across a bug in this library, please open an issue with a detailed description of what you've encountered

Development

If you don't have pnpm

npm install -g pnpm

Run the solid storybook dev environment:

pnpm i
pnpm dev

Theming

Theming in the context of solid-ui is a system for providing a set of values to control the look and feel of the components. Head over to our theming documentation for more information