@idetik/react

🚨 This package is under active development. Use at your own risk in production environments.

React components for interactive visualization of large datasets, built on the Idetik runtime.

Getting Started

Prerequisites

• Node.js v20.19.0 or later (required)
• npm

Installation

1. Clone the repository:

   git clone <repository-url>
   cd idetik-react

2. Install dependencies:

   npm install

3. Build the library:

   npm run build

Development

• Start dev server: npm run dev
• Run tests: npm test
• Run tests with coverage: npm run test-with-coverage
• Lint code: npm run lint
• Format code: npm run format
• Check formatting: npm run format-check

Publishing

Releases are automated using semantic-release when PRs are merged to main. The version and changelog are automatically determined from commit messages.

Conventional Commits

All PR titles must follow the Conventional Commits format:

<type>(<scope>): <description>

Examples:
- feat(slider): add new dimension slider component
- fix(viewer): resolve memory leak in image rendering
- docs: update installation instructions

Types and Version Bumps:

• feat: - New feature (minor version bump: 7.0.0 → 7.1.0)
• fix: - Bug fix (patch version bump: 7.0.0 → 7.0.1)
• perf: - Performance improvement (patch version bump)
• refactor: - Code refactoring (patch version bump)
• docs:, style:, test:, build:, ci:, chore: - No release

Breaking Changes: Add ! after type or include BREAKING CHANGE: in PR body for major version bump (7.0.0 → 8.0.0):

feat!: remove deprecated API

Manual Publishing (if needed)

If you need to publish manually:

npm install
npm run build
npm login
npm run pub

Dependencies

This package depends on @idetik/core as both a peer dependency and dev dependency. Make sure your consuming application also has the core package installed.

Project Structure

├── src/                    # Source code
│   ├── components/         # React components
│   │   ├── providers/      # Context providers
│   │   └── viewers/        # Viewer components (OmeZarrImageViewer, etc.)
│   └── hooks/              # Custom React hooks
├── examples/               # Example applications
├── test/                   # Test files
└── dist/                   # Built output (generated)