Skip to content

readme.md

Latest commit

 

History

History
77 lines (57 loc) · 1.13 KB

readme.md

File metadata and controls

77 lines (57 loc) · 1.13 KB

TegoSheet (@tego/sheet)

A high-performance spreadsheet component for React, combining React's declarative UI with Canvas rendering.

Installation

pnpm install @tego/sheet

Quick Start

Basic Usage

import { TegoSheet } from '@tego/sheet';

function App() {
  return <TegoSheet />;
}

With Options

<TegoSheet
  options={{
    mode: 'edit',        // 'edit' | 'read'
    showToolbar: true,
    showBottomBar: true,
    showGrid: true,
  }}
/>

Load Data

import { TegoSheet, useSheetStore } from '@tego/sheet';
import { useEffect } from 'react';

function App() {
  const { loadData } = useSheetStore();

  useEffect(() => {
    loadData([
      {
        name: 'Sheet1',
        rows: {
          0: { cells: { 0: { text: 'A1' }, 1: { text: 'B1' } } },
          1: { cells: { 0: { text: 'A2' }, 1: { text: 'B2' } } },
        },
      },
    ]);
  }, []);

  return <TegoSheet />;
}

Listen to Changes

<TegoSheet
  onChange={(data) => {
    console.log('Sheet data changed:', data);
  }}
/>

Documentation

See docs for full API documentation.

License

MIT