@movable/ui

todo: update

This repo contains the shared components for our frontend applications. Using this react component library guide

Local Development

Installation

1. Ensure you have volta installed on your computer
2. Clone the repo
3. npm install (note: npm, not yarn)

Usage

Ensure the project consuming this library has all the required peer dependencies.

WARNING: Providing Theme Colors to Custom Components

While within using app you'll be able to use (theme) => theme.palette... style of sx props. But within our custom component this does NOT traverse to the using app. You'll want to use the theme palette directly to ensure proper color strings. See #224

import palette from 'path_to_src/theme/palette';

export default InkCustomComponent() {
  return (
    <Box sx={{ backgroundColor: palette.neutral50 }}>
      ...
    </Box>
  )
}

Alpha Pre-release Workflow

This project supports alpha releases for testing changes before full releases.

Manual Alpha Release

For testing specific features or changes:

1. Navigate to Actions tab in GitHub repository
2. Select "Release to NPM" workflow
3. Click "Run workflow" button
4. Configure options:
   • release_type: Select prerelease
   • dist_tag: Leave as alpha or customize (e.g., beta, feature-test)
   • increment: Leave empty for auto-increment or specify (patch, minor, major)
5. Click "Run workflow" to trigger the release

Result: Creates version like 3.4.1-alpha.0 and publishes to npm with @alpha tag

Using Alpha Versions in Other Projects

Install alpha versions in your consuming projects:

# Install latest alpha
npm install @movable/ui@alpha
yarn add @movable/ui@alpha

# Install specific alpha version
npm install @movable/[email protected]
yarn add @movable/[email protected]

View all available versions at: https://www.npmjs.com/package/@movable/ui?activeTab=versions

MCP Server

This repo includes an MCP (Model Context Protocol) server that exposes component information to AI assistants like Claude Code. See mcp-server/README.md for setup instructions.

Conventional Commits

This repo has conventional-commits We lint for this both pre-commit and on PR actions. It is required and will not pass without it.

Ex:

fix(percy): added percy snapshots for all component states

- active
- disabled
- focused