@lateralus-ai/shipping-ui
v1.4.14
Published
Shared UI theme and components for Lateralus shipping applications
Readme
@lateralus-ai/shipping-ui
Shared UI theme and design system for Lateralus shipping applications.
Features
- Material Tailwind theme configuration
- Custom color palette (Gray, Green, Blue, Red, Orange)
- Typography styles (subheader, body, caption, footnote variations)
- CSS variables for theming
- Light/Dark mode support
- Storybook for component documentation
Development
Setup
npm installRun Storybook
npm run dev
# or
npm run storybookStorybook will be available at http://localhost:6006
Build Storybook
npm run build
# or
npm run build-storybookUsing the Theme in Your Project
1. Install the package (when published)
npm install @lateralus-ai/shipping-ui2. Import the Tailwind configuration
In your tailwind.config.js:
const shippingUIConfig = require("@lateralus-ai/shipping-ui/tailwind");
module.exports = shippingUIConfig;Or extend it:
const shippingUIConfig = require("@lateralus-ai/shipping-ui/tailwind");
module.exports = {
...shippingUIConfig,
content: [
"./src/**/*.{js,jsx,ts,tsx}",
"./node_modules/@lateralus-ai/shipping-ui/**/*.{js,jsx,ts,tsx}",
],
// Your additional configuration
};3. Import the global styles
In your main CSS file:
@import "@lateralus-ai/shipping-ui/style.css";Theme Structure
Typography Classes
text-subheader/text-subheader-em- 18px/28pxtext-body/text-body-em- 16px/28pxtext-caption-1/text-caption-1-em- 16px/22pxtext-caption-2/text-caption-2-em- 14px/20pxtext-footnote/text-footnote-em- 13px/17px
Color Palette
- Gray: 50-900
- Green: 50-900 (primary brand color)
- Blue: 50-900
- Red: 50-900
- Orange: 50-900
- Brand Purple: #ab68ff
Font Families
- Sans: Work Sans
- Mono: Roboto Mono
- Signature: Cursive fonts for signatures
License
UNLICENSED - Proprietary software
