idetik react components
npm install @idetik/react-prereleasešØ 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.
- Node.js v20.19.0 or later (required)
- npm
1. Clone the repository:
``bash`
git clone
cd idetik-react
2. Install dependencies:
`bash`
npm install
3. Build the library:
`bash`
npm run build
Note: The build currently has TypeScript errors related to features from @idetik/core-prerelease that are not yet in the published version. The library builds successfully, but TypeScript compilation fails. These errors will be resolved when the core package is updated.
- Start dev server: npm run devnpm test
- Run tests: npm run test-with-coverage
- Run tests with coverage: npm run lint
- Lint code: npm run format
- Format code: npm run format-check
- Check formatting:
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:
`
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:
`bash`
npm install
npm run build
npm login
npm run pub
This package depends on @idetik/core-prerelease as both a peer dependency and dev dependency. Make sure your consuming application also has the core package installed.
```
āāā 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)