Skip to content

Commit 96858d5

Browse files
authored
docs: improve readme documentation
1 parent f5b3f44 commit 96858d5

File tree

1 file changed

+1
-1
lines changed
  • packages/excel-builder-vanilla-types

1 file changed

+1
-1
lines changed

packages/excel-builder-vanilla-types/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This package contains only the shared types and interfaces of `excel-builder-vanilla`'s package.
44

5-
A use-case for `@excel-builder-vanilla/types` is when you want to import `excel-builder-vanilla`'s types in order to create custom interfaces **but** without importing the entire `excel-builder-vanilla` package. This was mainly created so that we can use it in Slickgrid-Universal as potential options in the grid options interface but still keep the Excel Export as an optional install, so importing only the types is much smaller for users who will never install the Excel Export.
5+
A simple use-case for `@excel-builder-vanilla/types` is when you want to only import `excel-builder-vanilla`'s types in order to create custom interfaces without importing the entire `excel-builder-vanilla` package. This was mainly created so that I can use it to create some interfaces in my data grid project (Slickgrid-Universal) as potential grid options without installing the Excel-Builder-Vanilla library because that is an optional plugin in my data grid project. So importing only the types is much smaller for users who might never install the Excel Export plugin.
66

77
```ts
88
import type { ExcelStyleInstruction, Worksheet, Workbook } from '@excel-builder-vanilla/types';

0 commit comments

Comments
 (0)