Breeze Forms

React form components, built with Tailwind CSS and ShadCN

Resources

• Github repo
• Distribution
  • npm registry
• Building blocks
  • TailwindCSS
  • shadcn-ui
    • color themes
  • Vite
  • Vitest
• Documentation via Storybook
  • Github Pages - docs only
  • Chromatic - full suite of stories
• Development
  • Chromatic builds
  • CodeCov
  • Renovate
• Other documentation, documents
  • Changelog
  • Roadmap

Usage

Installation

When using Vite, Breeze must be included in your primary .css file in order to ensure the necessary CSS classes are included in the build. For more details, read the Tailwind CSS documentation on explicitly registering sources.

Example index.css:

@import "tailwindcss";
@source "../node_modules/@jszymanowski/breeze-primitives/dist";

@layer base {
  /* your usual CSS definitions */
}

Releases & Publishing

Releases are automated using Release Please:

1. When a PR is merged to main, Release Please will analyze recent commits to determine if and how a release should be structured.
2. A PR with necessary changes to make a release will be opened. This will include:
   • version bump
   • changelog updates
3. Once merged, the release will be completed but not published. Release Please will:
   • create a Git tag (like v1.2.3) corresponding to the released version
   • create a GitHub Release with the changelog as release notes
4. The publish Github Action will detect the new tag and publish the release.
5. The new version will be available from the NPM registry