Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ export default defineConfig(
},
rules: {
'curly': ['error', 'all'],
'@typescript-eslint/no-unused-vars': ['error', {
argsIgnorePattern: '^_'
}],
'@stylistic/semi': ['error', 'always'],
'@stylistic/quotes': ['error', 'single', { avoidEscape: true }],
'@stylistic/brace-style': ['error', '1tbs', { allowSingleLine: true }],
Expand Down
13 changes: 13 additions & 0 deletions examples/grid-lite/components-react/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Highcharts Grid Lite - React Example</title>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>

26 changes: 26 additions & 0 deletions examples/grid-lite/components-react/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"name": "grid-lite-minimal-react",
"version": "0.0.0",
"private": true,
"type": "module",
"scripts": {
"dev": "vite",
"build": "tsc && vite build",
"preview": "vite preview",
"clean": "rimraf dist node_modules"
},
"dependencies": {
"@highcharts/grid-lite": ">=3.0.0",
"@highcharts/grid-lite-react": "workspace:*",
"react": ">=18",
"react-dom": ">=18"
},
"devDependencies": {
"@types/react": ">=18",
"@types/react-dom": ">=18",
"@vitejs/plugin-react": "^4.2.0",
"typescript": "^5.0.0",
"vite": "^5.0.0"
}
}

142 changes: 142 additions & 0 deletions examples/grid-lite/components-react/src/App.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
import { useState, useRef } from 'react';
import {
type GridInstance,
type GridRefHandle,
type GridOptions,
Grid,
Caption,
Data,
DataTable,
ColumnDefaults,
Column,
Description
} from '@highcharts/grid-lite-react';

function App() {
const grid = useRef<GridRefHandle<GridOptions> | null>(null);

// ==== OPTIONS ====
// const [options] = useState<GridOptions>({
// dataTable: {
// columns: {
// name: ['1111Alice', 'Bob', 'Charlie', 'David', 'Eve'],
// age: [23, 34, 45, 56, 67],
// city: ['New York', 'Oslo', 'Paris', 'Tokyo', 'London'],
// salary: [50000, 60000, 70000, 80000, 90000]
// }
// }
// });

// ==== DATA ====
// Data Columns
const [dataSource, setDataSource] = useState({
name: ['COLUMNS', 'Bob', 'Charlie', 'David', 'Eve'],
age: [23, 34, 45, 56, 67],
city: ['New York', 'Oslo', 'Paris', 'Tokyo', 'London'],
salary: [50000, 60000, 70000, 80000, 90000]
});

// Data Table
// const dataTable = new DataTable({
// columns: {
// name: ['DATATABLE', 'Bob', 'Charlie', 'David', 'Eve'],
// age: [23, 34, 45, 56, 67],
// city: ['New York', 'Oslo', 'Paris', 'Tokyo', 'London'],
// salary: [50000, 60000, 70000, 80000, 90000]
// }
// });

// ==== ACTIONS ====
const onButtonClick = () => {
// console.info('(ref) grid:', grid.current?.grid);
setDataSource({
name: ['John', 'Jane', 'Jim', 'Jill', 'Jack'],
age: [30, 25, 35, 40, 45],
city: ['New York', 'Los Angeles', 'Chicago', 'Houston', 'Miami'],
salary: [40000, 35000, 45000, 50000, 55000]
});
};

const onGridCallback = (grid: GridInstance<GridOptions>) => {
console.info('(callback) grid:', grid);
};

return (
<>
<Grid
// options={options}
// gridRef={grid}
callback={onGridCallback}
>
<Data
// dataTable={dataTable}
columns={dataSource}
/>
<ColumnDefaults
dataType="string"
width="auto"
exportable
style={{ fontWeight: '400' }}
sortingEnabled
sortingOrderSequence={['asc', 'desc', null]}
filteringEnabled
filteringInline={true}
filteringCondition="contains"
filteringValue=""
headerClassName="hcg-default-header"
headerFormat="{id}"
cellClassName="hcg-default-cell"
cellFormat="{value}"
cellRowHeader={false}
/>
<Caption>Grid Caption v2.1</Caption>
<Column
headerFormat="#"
width={40}
cellValueGetter={function (this: { row: { index: number } }) {
return String(this.row.index + 1);
}}
/>
<Column
columnId="name"
className="hcg-name-column"
enabled
sortingEnabled
sortingOrder="asc"
sortingPriority={0}
// filteringEnabled
// filteringInline
// filteringCondition="contains"
headerClassName="hcg-name-header"
headerFormat="Name"
cellClassName="hcg-name-cell"
cellFormat="{value}"
/>
<Column
columnId="age"
dataType="number"
headerFormat="Age ({id})"
cellFormat="{value}"
/>
<Column
columnId="city"
width="20%"
headerFormatter={function () {
return `City: ${(this as { id?: string }).id ?? ''}`;
}}
/>
<Column
columnId="salary"
dataType="number"
headerFormat="Salary (USD)"
cellFormat="${value}"
/>
<Description>Grid Description</Description>
{/* <Pagination>Grid Pagination</Pagination> */}
</Grid>
<button onClick={onButtonClick}>Click me</button>
</>
);
}

export default App;
26 changes: 26 additions & 0 deletions examples/grid-lite/components-react/src/index.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
* {
margin: 0;
padding: 0;
box-sizing: border-box;
}

body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}

#root {
width: 100%;
min-height: 100vh;
padding: 20px;
}

@media (prefers-color-scheme: dark) {
body {
background-color: #121212;
color: #ffffff;
}
}
11 changes: 11 additions & 0 deletions examples/grid-lite/components-react/src/main.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import React from 'react';
import ReactDOM from 'react-dom/client';
import App from './App';
import './index.css';

ReactDOM.createRoot(document.getElementById('root')!).render(
<React.StrictMode>
<App />
</React.StrictMode>
);

28 changes: 28 additions & 0 deletions examples/grid-lite/components-react/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"compilerOptions": {
"target": "ES2020",
"lib": [
"DOM",
"ES2016",
"ES2017.Object"
],
"jsx": "react-jsx",
"module": "ES6",
"moduleResolution": "node",
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"strict": true,
"noImplicitThis": true,
"noFallthroughCasesInSwitch": true,
"skipDefaultLibCheck": true,
"skipLibCheck": true,
"ignoreDeprecations": "5.0",
"allowSyntheticDefaultImports": true,
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true
},
"include": ["src"],
"references": [{ "path": "./tsconfig.node.json" }]
}

12 changes: 12 additions & 0 deletions examples/grid-lite/components-react/tsconfig.node.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"compilerOptions": {
"composite": true,
"skipLibCheck": true,
"module": "ESNext",
"moduleResolution": "bundler",
"allowSyntheticDefaultImports": true,
"types": ["node"]
},
"include": ["vite.config.ts"]
}

30 changes: 30 additions & 0 deletions examples/grid-lite/components-react/vite.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import { resolve, dirname } from 'path';
import { fileURLToPath } from 'url';

const __dirname = dirname(fileURLToPath(import.meta.url));

export default defineConfig({
plugins: [react()],
resolve: {
alias: [
{
find: '@highcharts/grid-lite-react',
replacement: resolve(__dirname, '../../../packages/grid-lite-react/src/index.ts')
},
{
find: '@highcharts/grid-shared-react',
replacement: resolve(__dirname, '../../../packages/grid-shared-react/src/index.ts')
},
{
find: /^@highcharts\/grid-lite(\/.*)?$/,
replacement: resolve(__dirname, 'node_modules/@highcharts/grid-lite$1')
}
]
},
server: {
port: 3000
}
});

29 changes: 26 additions & 3 deletions packages/grid-lite-react/src/Grid.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,37 @@
*
*/

import { useMemo } from 'react';
import {
BaseGrid,
GridProps
GridProps,
getChildProps
} from '@highcharts/grid-shared-react';
import { merge } from '@highcharts/grid-lite/es-modules/Shared/Utilities.js';
import Grid from '@highcharts/grid-lite/es-modules/masters/grid-lite.src';
import '@highcharts/grid-lite/css/grid-lite.css';
import type { Options } from '@highcharts/grid-lite/es-modules/Grid/Core/Options';

export default function GridLite({ options, gridRef, callback }: GridProps<Options>) {
return <BaseGrid options={options} Grid={Grid} ref={gridRef} callback={callback} />;
export default function GridLite(props: GridProps<Options>) {
const { gridRef, children, options, ...gridProps } = props;
const childOptions = useMemo(() => getChildProps(children), [children]);
const columnKey = useMemo(() => {
const columns = childOptions.columns as Array<{ id?: string }> | undefined;

return columns?.map((column) => column.id).join('\0') ?? '';
}, [childOptions]);
const gridOptions = useMemo(
() => merge(childOptions, options ?? {}) as Options,
[childOptions, options]
);

return (
<BaseGrid
key={columnKey}
{...gridProps}
options={gridOptions}
Grid={Grid}
ref={gridRef}
/>
);
}
19 changes: 17 additions & 2 deletions packages/grid-lite-react/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,21 @@ import GridLite from '@highcharts/grid-lite';

export { default as Grid } from './Grid';
export { default as GridLite } from './Grid';
export type { GridInstance } from '@highcharts/grid-shared-react';
export type { GridRefHandle } from '@highcharts/grid-shared-react';
export { Caption, Data, ColumnDefaults, Column, Description } from '@highcharts/grid-shared-react';
export { DataTable, DataConnector } from '@highcharts/grid-lite';
export { merge } from '@highcharts/grid-lite/es-modules/Shared/Utilities.js';
export type {
GridInstance,
GridRefHandle,
CaptionProps,
DescriptionProps,
DataProps,
DataColumns,
DataColumnValue,
ColumnProps,
ColumnOptionsProps,
ColumnDataType,
ColumnSortingOrder,
CellValueGetterContext
} from '@highcharts/grid-shared-react';
export type GridOptions = GridLite.Options;
Loading
Loading