@circutor/solid-ui v5.2.4

@circutor/solid-ui

A comprehensive library of reusable UI components for SolidJS projects.

Overview

This library provides a set of pre-built, customizable UI components to accelerate development of SolidJS applications. It builds upon the @circutor/ui library as a foundation.

Installation

npm install @circutor/solid-ui @circutor/ui

Quick Start

import { CdsCard } from '@circutor/solid-ui';

function App() {
  return (
    <CdsCard>
      <h2>Hello from Circutor UI!</h2>
      <p>This is a simple example of using the Card component.</p>
    </CdsCard>
  );
}

Documentation

For full component documentation and examples, please visit our https://gitlab.com/circutor/frontend/solid-cds-docs.

Development

Setup and Build

Clone the repository and install dependencies:

git clone https://github.com/circutor/solid-ui.git
cd solid-ui
npm install
npm run build

Development Workflow

Adding New Components

1. Create your component in the appropriate directory under /packages/circutor-solid-ui/src/lib/
2. Export the component from /packages/circutor-solid-ui/src/index.ts:

   export * from './lib/your-component/YourComponent';

Testing Components During Development

To test components in a development environment:

npm run dev

This will start the development server with a test application in the dev directory where you can test your components without building the entire library.

Testing in Other Projects Without Publishing

To test the library in another project without publishing to npm:

1. Build the library

   npm run build

2. Create a tarball package

   npm pack

3. Install the tarball in your target project

   # In your target project directory
   npm install /path/to/circutor-solid-ui-<version>.tgz

Building

# Build the entire project
npm run build

# Or build just the solid-ui package
npm run build -w @circutor/solid-ui

Testing

Run the unit tests using Vitest:

npm run test

Linting

Lint the project using ESLint:

npm run lint

Release Process

1. Create an Issue describing the change

   • Format: feat(scope): describe the feature

2. Create a Merge Request with a branch name based on the issue (edit name)

   • Format: feat/scope_feature_description (no spaces)

3. Make Code Changes

   • Implement the feature or fix

4. Update Documentation

   • Update the changelog and version

5. Create a Release Commit

   • To release a new version, create a commit to the main branch with one of these tags in the commit message:
     • [patch] - Bug fixes
     • [minor] - New features, backward compatible
     • [major] - Breaking changes