@leta-io/components 0.1.0

package/README.md

@@ -0,0 +1,42 @@
+# @leta-io/components
+
+React component library for the LETA design system. Components are styled from
+design tokens at runtime — no CSS-in-JS build step and no stylesheet to import
+per component.
+
+```bash
+npm install @leta-io/components @leta-io/design-tokens
+```
+
+Load the tokens once, at your app's entry point, then use components normally:
+
+```tsx
+import '@leta-io/design-tokens/css';
+import '@leta-io/design-tokens/text-styles.css';
+
+import { SideBar, TopBar, Table, Badge } from '@leta-io/components';
+```
+
+## Theming
+
+The dark palette applies via `data-theme="dark"` on `<html>`. There is no
+`prefers-color-scheme` block, so resolve the user's choice in JS and set the
+attribute. Import `@leta-io/design-tokens/dark-elevation.css` **after** the base
+tokens — dark shadows need a hairline ring to read against a near-black surface,
+and load order decides the winner.
+
+## Peer dependencies
+
+React 18 or 19. `leaflet` and `lottie-web` are required only if you use the map
+or loading-overlay components.
+
+## Notes
+
+- The package entry is a barrel. Importing from it pulls in the whole library,
+  including Leaflet and Lottie; import the component's own path if bundle size
+  matters.
+- Components never hardcode colours or sizes — every value resolves to a token
+  from `@leta-io/design-tokens`.
+
+The source repository is private; these packages are published for use across
+Leta's products.