Reef (@indico-data/reef)

A reusable Excel file viewer library with Permafrost design system styling, built for future cell-based annotation capabilities. Built on top of JSpreadsheet for Excel file viewing and structured data display.

Development

Prerequisites

• Node.js 18+
• Yarn

Installation

git clone <repository-url>
cd reef
yarn install

Available Scripts

Development

• yarn dev - Start Storybook development server on port 6006

Building

• yarn build - Build the library (Vite build + TypeScript declarations)
• yarn build-storybook - Build the Storybook static site

Code Quality

• yarn lint - Run ESLint on TypeScript and JavaScript files in the src directory

Versioning

This project uses semantic versioning with conventional commits. The version is automatically managed through semantic-release.

Commit Types:

• Fix: - Bug fixes (patch release)
• Update: - Minor updates (patch release)
• New: - New features (minor release)
• Breaking: - Breaking changes (major release)
• Docs: - Documentation updates
• Build: - Build system changes
• Upgrade: - Dependency upgrades
• Chore: - Maintenance tasks

Usage

import { ExcelViewer } from '@indico-data/reef';

function MyComponent() {
  return <ExcelViewer license="your-jspreadsheet-license" fileUrl="/api/files/spreadsheet.xlsx" />;
}