Skip to content

Commit 7ced5a0

Browse files
authored
docs: add more description about the types package need
1 parent c4057da commit 7ced5a0

File tree

1 file changed

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

1 file changed

+3
-3
lines changed
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# @excel-builder-vanilla/types
22

3-
This package contains only the shared types and interfaces of excel-builder-vanilla's package.
3+
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 to create a custom interface without importing the entire excel-builder-vanilla package.
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.
66

77
```ts
88
import type { ExcelStyleInstruction, Worksheet, Workbook } from '@excel-builder-vanilla/types';
@@ -13,4 +13,4 @@ export interface ExcelExportOption {
1313

1414
// ....
1515
}
16-
```
16+
```

0 commit comments

Comments
 (0)