Skip to content

Commit 15297ed

Browse files
committed
remove jsdoc links
1 parent 51aca77 commit 15297ed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+33
-746
lines changed

examples/react/shadcn-kitchen-sink/src/components/ui/badge.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ const badgeVariants = cva(
2424
)
2525

2626
export interface BadgeProps
27-
extends React.HTMLAttributes<HTMLDivElement>,
27+
extends
28+
React.HTMLAttributes<HTMLDivElement>,
2829
VariantProps<typeof badgeVariants> {}
2930

3031
function Badge({ className, variant, ...props }: BadgeProps) {

examples/react/shadcn-kitchen-sink/src/components/ui/button.tsx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ const buttonVariants = cva(
3636
)
3737

3838
export interface ButtonProps
39-
extends React.ButtonHTMLAttributes<HTMLButtonElement>,
39+
extends
40+
React.ButtonHTMLAttributes<HTMLButtonElement>,
4041
VariantProps<typeof buttonVariants> {
4142
asChild?: boolean
4243
}

examples/react/shadcn-kitchen-sink/src/components/ui/faceted.tsx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,9 @@ function useFacetedContext(name: keyof typeof ERRORS) {
6868
return context
6969
}
7070

71-
interface FacetedProps<Multiple extends boolean = false>
72-
extends React.ComponentPropsWithoutRef<typeof Popover> {
71+
interface FacetedProps<
72+
Multiple extends boolean = false,
73+
> extends React.ComponentPropsWithoutRef<typeof Popover> {
7374
value?: FacetedValue<Multiple>
7475
onValueChange?: (value: FacetedValue<Multiple> | undefined) => void
7576
children?: React.ReactNode
@@ -291,8 +292,9 @@ FacetedEmpty.displayName = EMPTY_NAME
291292
const FacetedGroup = CommandGroup
292293
FacetedGroup.displayName = GROUP_NAME
293294

294-
interface FacetedItemProps
295-
extends React.ComponentPropsWithoutRef<typeof CommandItem> {
295+
interface FacetedItemProps extends React.ComponentPropsWithoutRef<
296+
typeof CommandItem
297+
> {
296298
value: string
297299
}
298300

examples/react/shadcn-kitchen-sink/src/components/ui/sortable.tsx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -439,8 +439,7 @@ const SortableItem = React.forwardRef<HTMLDivElement, SortableItemProps>(
439439
)
440440
SortableItem.displayName = ITEM_NAME
441441

442-
interface SortableItemHandleProps
443-
extends React.ComponentPropsWithoutRef<'button'> {
442+
interface SortableItemHandleProps extends React.ComponentPropsWithoutRef<'button'> {
444443
asChild?: boolean
445444
}
446445

@@ -499,8 +498,10 @@ const dropAnimation: DropAnimation = {
499498
}),
500499
}
501500

502-
interface SortableOverlayProps
503-
extends Omit<React.ComponentPropsWithoutRef<typeof DragOverlay>, 'children'> {
501+
interface SortableOverlayProps extends Omit<
502+
React.ComponentPropsWithoutRef<typeof DragOverlay>,
503+
'children'
504+
> {
504505
container?: HTMLElement | DocumentFragment | null
505506
children?:
506507
| ((params: { value: UniqueIdentifier }) => React.ReactNode)

examples/vanilla/pagination/src/main.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,11 @@ const renderTable = (table: Table<typeof _features, Person>) => {
7777
? ['cursor-pointer', 'select-none']
7878
: []),
7979
)
80-
;(divElement.onclick = (e) =>
80+
;((divElement.onclick = (e) =>
8181
header.column.getToggleSortingHandler()?.(e)),
8282
(divElement.innerHTML = header.isPlaceholder
8383
? ''
84-
: flexRender(header.column.columnDef.header, header.getContext()))
84+
: flexRender(header.column.columnDef.header, header.getContext())))
8585
divElement.innerHTML +=
8686
{
8787
asc: ' 🔼',

examples/vanilla/sorting/src/main.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ const renderTable = () => {
9292
? ['cursor-pointer', 'select-none']
9393
: []),
9494
)
95-
;(divElement.onclick = (e) =>
95+
;((divElement.onclick = (e) =>
9696
header.column.getToggleSortingHandler()?.(e)),
9797
(divElement.innerHTML = header.isPlaceholder
9898
? ''
99-
: flexRender(header.column.columnDef.header, header.getContext()))
99+
: flexRender(header.column.columnDef.header, header.getContext())))
100100
divElement.innerHTML +=
101101
{
102102
asc: ' 🔼',

packages/lit-table/src/TableController.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ import type { ReactiveController, ReactiveControllerHost } from 'lit'
1717
export class TableController<
1818
TFeatures extends TableFeatures,
1919
TData extends RowData,
20-
> implements ReactiveController
21-
{
20+
> implements ReactiveController {
2221
host: ReactiveControllerHost
2322

2423
private _features: TableFeatures | null = null

packages/table-core/src/core/cells/coreCellsFeature.types.ts

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,14 @@ export interface Cell_CoreProperties<
2525
> {
2626
/**
2727
* The associated Column object for the cell.
28-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#column)
29-
* [Guide](https://tanstack.com/table/v8/docs/guide/cells)
3028
*/
3129
column: Column<TFeatures, TData, TValue>
3230
/**
3331
* The unique ID for the cell across the entire table.
34-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#id)
35-
* [Guide](https://tanstack.com/table/v8/docs/guide/cells)
3632
*/
3733
id: string
3834
/**
3935
* The associated Row object for the cell.
40-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#row)
41-
* [Guide](https://tanstack.com/table/v8/docs/guide/cells)
4236
*/
4337
row: Row<TFeatures, TData>
4438
/**
@@ -54,29 +48,21 @@ export interface Cell_Cell<
5448
> extends Cell_CoreProperties<TFeatures, TData, TValue> {
5549
/**
5650
* Returns the rendering context (or props) for cell-based components like cells and aggregated cells. Use these props with your framework's `flexRender` utility to render these using the template of your choice:
57-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#getcontext)
58-
* [Guide](https://tanstack.com/table/v8/docs/guide/cells)
5951
*/
6052
getContext: () => CellContext<TFeatures, TData, TValue>
6153
/**
6254
* Returns the value for the cell, accessed via the associated column's accessor key or accessor function.
63-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#getvalue)
64-
* [Guide](https://tanstack.com/table/v8/docs/guide/cells)
6555
*/
6656
getValue: CellContext<TFeatures, TData, TValue>['getValue']
6757
/**
6858
* Renders the value for a cell the same as `getValue`, but will return the `renderFallbackValue` if no value is found.
69-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#rendervalue)
70-
* [Guide](https://tanstack.com/table/v8/docs/guide/cells)
7159
*/
7260
renderValue: CellContext<TFeatures, TData, TValue>['renderValue']
7361
}
7462

7563
export interface TableOptions_Cell {
7664
/**
7765
* Value used when the desired value is not found in the data.
78-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/table#renderfallbackvalue)
79-
* [Guide](https://tanstack.com/table/v8/docs/guide/tables)
8066
*/
8167
renderFallbackValue?: any
8268
}

packages/table-core/src/core/columns/coreColumnsFeature.types.ts

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -11,41 +11,29 @@ export interface Column_CoreProperties<
1111
> {
1212
/**
1313
* The resolved accessor function to use when extracting the value for the column from each row. Will only be defined if the column def has a valid accessor key or function defined.
14-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/column#accessorfn)
15-
* [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
1614
*/
1715
accessorFn?: AccessorFn<TData, TValue>
1816
/**
1917
* The original column def used to create the column.
20-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/column#columndef)
21-
* [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
2218
*/
2319
columnDef: ColumnDef<TFeatures, TData, TValue>
2420
/**
2521
* The child column (if the column is a group column). Will be an empty array if the column is not a group column.
26-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/column#columns)
27-
* [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
2822
*/
2923
columns: Array<Column<TFeatures, TData, TValue>>
3024
/**
3125
* The depth of the column (if grouped) relative to the root column def array.
32-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/column#depth)
33-
* [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
3426
*/
3527
depth: number
3628
/**
3729
* The resolved unique identifier for the column resolved in this priority:
3830
- A manual `id` property from the column def
3931
- The accessor key from the column def
4032
- The header string from the column def
41-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/column#id)
42-
* [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
4333
*/
4434
id: string
4535
/**
4636
* The parent column for this column. Will be undefined if this is a root column.
47-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/column#parent)
48-
* [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
4937
*/
5038
parent?: Column<TFeatures, TData, TValue>
5139
/**
@@ -61,14 +49,10 @@ export interface Column_Column<
6149
> extends Column_CoreProperties<TFeatures, TData, TValue> {
6250
/**
6351
* Returns the flattened array of this column and all child/grand-child columns for this column.
64-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/column#getflatcolumns)
65-
* [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
6652
*/
6753
getFlatColumns: () => Array<Column<TFeatures, TData, TValue>>
6854
/**
6955
* Returns an array of all leaf-node columns for this column. If a column has no children, it is considered the only leaf-node column.
70-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/column#getleafcolumns)
71-
* [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
7256
*/
7357
getLeafColumns: () => Array<Column<TFeatures, TData, TValue>>
7458
}
@@ -80,14 +64,10 @@ export interface TableOptions_Columns<
8064
> {
8165
/**
8266
* The array of column defs to use for the table.
83-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/table#columns)
84-
* [Guide](https://tanstack.com/table/v8/docs/guide/tables)
8567
*/
8668
columns: Array<ColumnDef<TFeatures, TData, TValue>>
8769
/**
8870
* Default column options to use for all column defs supplied to the table.
89-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/table#defaultcolumn)
90-
* [Guide](https://tanstack.com/table/v8/docs/guide/tables)
9171
*/
9272
defaultColumn?: Partial<ColumnDef<TFeatures, TData, TValue>>
9373
}
@@ -98,38 +78,26 @@ export interface Table_Columns<
9878
> {
9979
/**
10080
* Returns a map of all flat columns by their ID.
101-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallflatcolumnsbyid)
102-
* [Guide](https://tanstack.com/table/v8/docs/guide/tables)
10381
*/
10482
getAllFlatColumnsById: () => Record<string, Column<TFeatures, TData, unknown>>
10583
/**
10684
* Returns the default column options to use for all column defs supplied to the table.
107-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getdefaultcolumndef)
108-
* [Guide](https://tanstack.com/table/v8/docs/guide/tables)
10985
*/
11086
getDefaultColumnDef: () => Partial<ColumnDef<TFeatures, TData, unknown>>
11187
/**
11288
* Returns all columns in the table in their normalized and nested hierarchy.
113-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallcolumns)
114-
* [Guide](https://tanstack.com/table/v8/docs/guide/tables)
11589
*/
11690
getAllColumns: () => Array<Column<TFeatures, TData, unknown>>
11791
/**
11892
* Returns all columns in the table flattened to a single level.
119-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallflatcolumns)
120-
* [Guide](https://tanstack.com/table/v8/docs/guide/tables)
12193
*/
12294
getAllFlatColumns: () => Array<Column<TFeatures, TData, unknown>>
12395
/**
12496
* Returns all leaf-node columns in the table flattened to a single level. This does not include parent columns.
125-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallleafcolumns)
126-
* [Guide](https://tanstack.com/table/v8/docs/guide/tables)
12797
*/
12898
getAllLeafColumns: () => Array<Column<TFeatures, TData, unknown>>
12999
/**
130100
* Returns a single column by its ID.
131-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getcolumn)
132-
* [Guide](https://tanstack.com/table/v8/docs/guide/tables)
133101
*/
134102
getColumn: (columnId: string) => Column<TFeatures, TData, unknown> | undefined
135103
}

packages/table-core/src/core/headers/coreHeadersFeature.types.ts

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,18 @@ export interface Table_Headers<
1111
> {
1212
/**
1313
* Returns all header groups for the table.
14-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getheadergroups)
15-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
1614
*/
1715
getHeaderGroups: () => Array<HeaderGroup<TFeatures, TData>>
1816
/**
1917
* Returns the footer groups for the table.
20-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getfootergroups)
21-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
2218
*/
2319
getFooterGroups: () => Array<HeaderGroup<TFeatures, TData>>
2420
/**
2521
* Returns headers for all columns in the table, including parent headers.
26-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getflatheaders)
27-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
2822
*/
2923
getFlatHeaders: () => Array<Header<TFeatures, TData, unknown>>
3024
/**
3125
* Returns headers for all leaf columns in the table, (not including parent headers).
32-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleafheaders)
33-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
3426
*/
3527
getLeafHeaders: () => Array<Header<TFeatures, TData, unknown>>
3628
}
@@ -61,62 +53,42 @@ export interface Header_CoreProperties<
6153
> {
6254
/**
6355
* The col-span for the header.
64-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#colspan)
65-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
6656
*/
6757
colSpan: number
6858
/**
6959
* The header's associated column object.
70-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#column)
71-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
7260
*/
7361
column: Column<TFeatures, TData, TValue>
7462
/**
7563
* The depth of the header, zero-indexed based.
76-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#depth)
77-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
7864
*/
7965
depth: number
8066
/**
8167
* The header's associated header group object.
82-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#headergroup)
83-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
8468
*/
8569
headerGroup: HeaderGroup<TFeatures, TData> | null
8670
/**
8771
* The unique identifier for the header.
88-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#id)
89-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
9072
*/
9173
id: string
9274
/**
9375
* The index for the header within the header group.
94-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#index)
95-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
9676
*/
9777
index: number
9878
/**
9979
* A boolean denoting if the header is a placeholder header.
100-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#isplaceholder)
101-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
10280
*/
10381
isPlaceholder: boolean
10482
/**
10583
* If the header is a placeholder header, this will be a unique header ID that does not conflict with any other headers across the table.
106-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#placeholderid)
107-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
10884
*/
10985
placeholderId?: string
11086
/**
11187
* The row-span for the header.
112-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#rowspan)
113-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
11488
*/
11589
rowSpan: number
11690
/**
11791
* The header's hierarchical sub/child headers. Will be empty if the header's associated column is a leaf-column.
118-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#subheaders)
119-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
12092
*/
12193
subHeaders: Array<Header<TFeatures, TData, TValue>>
12294
/**
@@ -132,14 +104,10 @@ export interface Header_Header<
132104
> extends Header_CoreProperties<TFeatures, TData, TValue> {
133105
/**
134106
* Returns the rendering context (or props) for column-based components like headers, footers and filters.
135-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getcontext)
136-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
137107
*/
138108
getContext: () => HeaderContext<TFeatures, TData, TValue>
139109
/**
140110
* Returns the leaf headers hierarchically nested under this header.
141-
* [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getleafheaders)
142-
* [Guide](https://tanstack.com/table/v8/docs/guide/headers)
143111
*/
144112
getLeafHeaders: () => Array<Header<TFeatures, TData, TValue>>
145113
}

0 commit comments

Comments
 (0)