@atlaskit/table 0.15.2 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +35 -0
- package/body/package.json +1 -8
- package/dist/cjs/head-cell.js +0 -2
- package/dist/cjs/hooks/selection-provider.js +2 -0
- package/dist/cjs/hooks/use-expand-content.js +2 -0
- package/dist/cjs/hooks/use-expand.js +2 -0
- package/dist/cjs/hooks/use-row-id.js +1 -0
- package/dist/cjs/hooks/use-selectable.js +2 -0
- package/dist/cjs/hooks/use-table-body.js +2 -0
- package/dist/cjs/hooks/use-table.js +2 -0
- package/dist/es2019/head-cell.js +0 -2
- package/dist/es2019/hooks/selection-provider.js +2 -0
- package/dist/es2019/hooks/use-expand-content.js +2 -0
- package/dist/es2019/hooks/use-expand.js +2 -0
- package/dist/es2019/hooks/use-row-id.js +1 -0
- package/dist/es2019/hooks/use-selectable.js +2 -0
- package/dist/es2019/hooks/use-table-body.js +2 -0
- package/dist/es2019/hooks/use-table.js +2 -0
- package/dist/esm/head-cell.js +0 -2
- package/dist/esm/hooks/selection-provider.js +2 -0
- package/dist/esm/hooks/use-expand-content.js +2 -0
- package/dist/esm/hooks/use-expand.js +2 -0
- package/dist/esm/hooks/use-row-id.js +1 -0
- package/dist/esm/hooks/use-selectable.js +2 -0
- package/dist/esm/hooks/use-table-body.js +2 -0
- package/dist/esm/hooks/use-table.js +2 -0
- package/dist/types/hooks/selection-provider.d.ts +1 -2
- package/expandable-cell/package.json +1 -8
- package/expandable-row/package.json +1 -8
- package/expandable-row-content/package.json +1 -8
- package/head-cell/package.json +1 -8
- package/package.json +18 -57
- package/primitives/bulk-action-overlay/package.json +1 -8
- package/primitives/expand-icon/package.json +1 -8
- package/primitives/expandable-cell/package.json +1 -8
- package/primitives/package.json +1 -8
- package/primitives/selectable-cell/package.json +1 -8
- package/primitives/sort-icon/package.json +1 -8
- package/primitives/table/package.json +1 -8
- package/primitives/tbody/package.json +1 -8
- package/primitives/td/package.json +1 -8
- package/primitives/th/package.json +1 -8
- package/primitives/thead/package.json +1 -8
- package/primitives/tr/package.json +1 -8
- package/row/package.json +1 -8
- package/sortable-column/package.json +1 -8
- package/table/package.json +1 -8
- package/td/package.json +1 -8
- package/thead/package.json +1 -8
- package/dist/types-ts4.5/body.d.ts +0 -13
- package/dist/types-ts4.5/entry-points/body.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/expandable-cell.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/expandable-row-content.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/expandable-row.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/head-cell.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-bulk-action-overlay.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-expand-icon.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-expandable-cell.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-selectable-cell.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-sort-icon.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-table.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-tbody.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-td.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-th.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-thead.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/primitives-tr.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/row.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/sortable-column.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/table.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/td.d.ts +0 -1
- package/dist/types-ts4.5/entry-points/thead.d.ts +0 -1
- package/dist/types-ts4.5/expandable-cell.d.ts +0 -9
- package/dist/types-ts4.5/expandable-row-content.d.ts +0 -12
- package/dist/types-ts4.5/expandable-row.d.ts +0 -19
- package/dist/types-ts4.5/head-cell.d.ts +0 -9
- package/dist/types-ts4.5/hooks/selection-provider.d.ts +0 -21
- package/dist/types-ts4.5/hooks/use-expand-content.d.ts +0 -15
- package/dist/types-ts4.5/hooks/use-expand.d.ts +0 -17
- package/dist/types-ts4.5/hooks/use-row-id.d.ts +0 -9
- package/dist/types-ts4.5/hooks/use-selectable.d.ts +0 -41
- package/dist/types-ts4.5/hooks/use-sorting.d.ts +0 -7
- package/dist/types-ts4.5/hooks/use-table-body.d.ts +0 -6
- package/dist/types-ts4.5/hooks/use-table.d.ts +0 -24
- package/dist/types-ts4.5/index.d.ts +0 -10
- package/dist/types-ts4.5/row.d.ts +0 -21
- package/dist/types-ts4.5/selectable-cell.d.ts +0 -3
- package/dist/types-ts4.5/sortable-column.d.ts +0 -25
- package/dist/types-ts4.5/table.d.ts +0 -28
- package/dist/types-ts4.5/thead.d.ts +0 -7
- package/dist/types-ts4.5/ui/base-cell.d.ts +0 -55
- package/dist/types-ts4.5/ui/bulk-action-overlay.d.ts +0 -9
- package/dist/types-ts4.5/ui/expand-icon.d.ts +0 -9
- package/dist/types-ts4.5/ui/expandable-cell.d.ts +0 -12
- package/dist/types-ts4.5/ui/index.d.ts +0 -14
- package/dist/types-ts4.5/ui/selectable-cell.d.ts +0 -12
- package/dist/types-ts4.5/ui/sort-icon.d.ts +0 -9
- package/dist/types-ts4.5/ui/table.d.ts +0 -30
- package/dist/types-ts4.5/ui/tbody.d.ts +0 -12
- package/dist/types-ts4.5/ui/td.d.ts +0 -10
- package/dist/types-ts4.5/ui/th.d.ts +0 -15
- package/dist/types-ts4.5/ui/thead.d.ts +0 -15
- package/dist/types-ts4.5/ui/tr.d.ts +0 -37
package/table/package.json
CHANGED
|
@@ -6,12 +6,5 @@
|
|
|
6
6
|
"sideEffects": [
|
|
7
7
|
"**/*.compiled.css"
|
|
8
8
|
],
|
|
9
|
-
"types": "../dist/types/entry-points/table.d.ts"
|
|
10
|
-
"typesVersions": {
|
|
11
|
-
">=4.5 <5.9": {
|
|
12
|
-
"*": [
|
|
13
|
-
"../dist/types-ts4.5/entry-points/table.d.ts"
|
|
14
|
-
]
|
|
15
|
-
}
|
|
16
|
-
}
|
|
9
|
+
"types": "../dist/types/entry-points/table.d.ts"
|
|
17
10
|
}
|
package/td/package.json
CHANGED
|
@@ -6,12 +6,5 @@
|
|
|
6
6
|
"sideEffects": [
|
|
7
7
|
"**/*.compiled.css"
|
|
8
8
|
],
|
|
9
|
-
"types": "../dist/types/entry-points/td.d.ts"
|
|
10
|
-
"typesVersions": {
|
|
11
|
-
">=4.5 <5.9": {
|
|
12
|
-
"*": [
|
|
13
|
-
"../dist/types-ts4.5/entry-points/td.d.ts"
|
|
14
|
-
]
|
|
15
|
-
}
|
|
16
|
-
}
|
|
9
|
+
"types": "../dist/types/entry-points/td.d.ts"
|
|
17
10
|
}
|
package/thead/package.json
CHANGED
|
@@ -6,12 +6,5 @@
|
|
|
6
6
|
"sideEffects": [
|
|
7
7
|
"**/*.compiled.css"
|
|
8
8
|
],
|
|
9
|
-
"types": "../dist/types/entry-points/thead.d.ts"
|
|
10
|
-
"typesVersions": {
|
|
11
|
-
">=4.5 <5.9": {
|
|
12
|
-
"*": [
|
|
13
|
-
"../dist/types-ts4.5/entry-points/thead.d.ts"
|
|
14
|
-
]
|
|
15
|
-
}
|
|
16
|
-
}
|
|
9
|
+
"types": "../dist/types/entry-points/thead.d.ts"
|
|
17
10
|
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import React, { type ReactElement } from 'react';
|
|
2
|
-
type BodyProps<Item extends object> = {
|
|
3
|
-
rows: Item[];
|
|
4
|
-
children: (row: Item) => ReactElement;
|
|
5
|
-
} | {
|
|
6
|
-
rows?: never;
|
|
7
|
-
children: ReactElement[] | ReactElement;
|
|
8
|
-
};
|
|
9
|
-
/**
|
|
10
|
-
* __Table body__
|
|
11
|
-
*/
|
|
12
|
-
declare function TBody<ObjectType extends object>({ rows, children, }: BodyProps<ObjectType>): React.JSX.Element;
|
|
13
|
-
export default TBody;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default as TBody } from '../body';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default as ExpandableCell } from '../expandable-cell';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default as ExpandableRowContent } from '../expandable-row-content';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default as ExpandableRow } from '../expandable-row';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default as HeadCell } from '../head-cell';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { BulkActionOverlay } from '../ui/bulk-action-overlay';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { ExpandIcon } from '../ui/expand-icon';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { ExpandableCell } from '../ui/expandable-cell';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { SelectableCell } from '../ui/selectable-cell';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { SortIcon } from '../ui/sort-icon';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { Table } from '../ui/table';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { TBody } from '../ui/tbody';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { TD } from '../ui/td';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { TH } from '../ui/th';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { THead } from '../ui/thead';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { TR } from '../ui/tr';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default as Row } from '../row';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default as SortableColumn } from '../sortable-column';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default } from '../table';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { TD as Cell } from '../ui/td';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { default as THead } from '../thead';
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
/**
|
|
3
|
-
* __Expandable cell__
|
|
4
|
-
*
|
|
5
|
-
* A cell with an expand button that controls the expanded state
|
|
6
|
-
* of the `<ExpandableRow>`.
|
|
7
|
-
*/
|
|
8
|
-
declare const ExpandableCell: React.MemoExoticComponent<() => React.JSX.Element>;
|
|
9
|
-
export default ExpandableCell;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
type ExpandableRowContentProps = {
|
|
3
|
-
children?: React.ReactNode;
|
|
4
|
-
};
|
|
5
|
-
/**
|
|
6
|
-
* __Expandable row content__
|
|
7
|
-
*
|
|
8
|
-
* Contains expandable content. Uses a context provider to allow children
|
|
9
|
-
* to identify if they are expandable content.
|
|
10
|
-
*/
|
|
11
|
-
declare const ExpandableRowContent: ({ children }: ExpandableRowContentProps) => React.JSX.Element;
|
|
12
|
-
export default ExpandableRowContent;
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
type ExpandableRowProps = {
|
|
3
|
-
children: React.ReactNode;
|
|
4
|
-
/**
|
|
5
|
-
* Controlled: If the row is expanded.
|
|
6
|
-
*/
|
|
7
|
-
isExpanded?: boolean;
|
|
8
|
-
/**
|
|
9
|
-
* Uncontrolled: If the row is expanded by default.
|
|
10
|
-
*/
|
|
11
|
-
isDefaultExpanded?: boolean;
|
|
12
|
-
};
|
|
13
|
-
/**
|
|
14
|
-
* __Expandable row__
|
|
15
|
-
*
|
|
16
|
-
* A context provider for `<Row>` to support expandable content.
|
|
17
|
-
*/
|
|
18
|
-
declare const ExpandableRow: ({ children, isExpanded, isDefaultExpanded, }: ExpandableRowProps) => React.JSX.Element;
|
|
19
|
-
export default ExpandableRow;
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
import React, { type FC, type ReactNode } from 'react';
|
|
2
|
-
import { type SelectableActions, type SelectableState } from './use-selectable';
|
|
3
|
-
type SelectionContext = [
|
|
4
|
-
SelectableState,
|
|
5
|
-
(
|
|
6
|
-
/**
|
|
7
|
-
* Context actions will be undefined without a `SelectionProvider` mounted.
|
|
8
|
-
*/
|
|
9
|
-
SelectableActions | Partial<SelectableActions>)
|
|
10
|
-
];
|
|
11
|
-
declare const SelectionContext: React.Context<SelectionContext>;
|
|
12
|
-
/**
|
|
13
|
-
* __Selection provider__
|
|
14
|
-
*
|
|
15
|
-
* A selection provider injects selection specific state into the table.
|
|
16
|
-
*/
|
|
17
|
-
declare const SelectionProvider: FC<{
|
|
18
|
-
children: ReactNode;
|
|
19
|
-
}>;
|
|
20
|
-
export declare const useSelection: () => SelectionContext;
|
|
21
|
-
export default SelectionProvider;
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
type ExpandContentContext = {
|
|
3
|
-
isExpandableContent: boolean;
|
|
4
|
-
};
|
|
5
|
-
declare const ExpandContentContext: React.Context<ExpandContentContext>;
|
|
6
|
-
/**
|
|
7
|
-
* __Expand content provider__
|
|
8
|
-
*
|
|
9
|
-
* An expand content provider allows `<Row>` to determine if it is a subitem.
|
|
10
|
-
*/
|
|
11
|
-
export declare const ExpandContentContextProvider: ({ children, }: {
|
|
12
|
-
children: React.ReactNode;
|
|
13
|
-
}) => React.JSX.Element;
|
|
14
|
-
declare const useExpandContent: () => ExpandContentContext;
|
|
15
|
-
export default useExpandContent;
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
type ExpandContextState = {
|
|
3
|
-
isExpanded: boolean;
|
|
4
|
-
toggleExpanded(): void;
|
|
5
|
-
};
|
|
6
|
-
/**
|
|
7
|
-
* __Expand context provider__
|
|
8
|
-
*
|
|
9
|
-
* An expand context provider.
|
|
10
|
-
*/
|
|
11
|
-
export declare const ExpandContextProvider: (props: {
|
|
12
|
-
children: React.ReactNode;
|
|
13
|
-
isExpanded?: boolean;
|
|
14
|
-
isDefaultExpanded?: boolean;
|
|
15
|
-
}) => React.JSX.Element;
|
|
16
|
-
declare const useExpand: () => ExpandContextState;
|
|
17
|
-
export default useExpand;
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
export type SelectableState = {
|
|
2
|
-
/**
|
|
3
|
-
* The localised ids that have been checked.
|
|
4
|
-
*/
|
|
5
|
-
checked: number[];
|
|
6
|
-
/**
|
|
7
|
-
* Whether all list items are checked.
|
|
8
|
-
*/
|
|
9
|
-
allChecked: boolean;
|
|
10
|
-
/**
|
|
11
|
-
* Whether any single row item is checked.
|
|
12
|
-
*/
|
|
13
|
-
anyChecked: boolean;
|
|
14
|
-
/**
|
|
15
|
-
* Equal to the data length of the table, i.e. the maximum number of checked items.
|
|
16
|
-
*/
|
|
17
|
-
maxChecked: number;
|
|
18
|
-
/**
|
|
19
|
-
* Indicates where a selection begins, i.e. the last selection where the Shift key was **not pressed**
|
|
20
|
-
*/
|
|
21
|
-
selectionStart: number;
|
|
22
|
-
/**
|
|
23
|
-
* Indicates the most recent selection range where the Shift key was pressed.
|
|
24
|
-
* This provides the ability to uncheck ids that are not part of a new selection range, but were in the previous selection range,
|
|
25
|
-
* mimicking behaviour such as that in macOS
|
|
26
|
-
* e.g. [2, 3, 4] indicates ids from 2 to 4 were selected the last time the Shift key was pressed.
|
|
27
|
-
*/
|
|
28
|
-
previousSelection: number[];
|
|
29
|
-
};
|
|
30
|
-
export type SelectableActions = {
|
|
31
|
-
setAll: () => void;
|
|
32
|
-
removeAll: () => void;
|
|
33
|
-
toggleSelection: (id: number, shiftHeld: boolean) => void;
|
|
34
|
-
setMax: (max: number) => void;
|
|
35
|
-
};
|
|
36
|
-
export declare const defaultSelectableState: SelectableState;
|
|
37
|
-
declare function useSelectable(): [
|
|
38
|
-
SelectableState,
|
|
39
|
-
SelectableActions
|
|
40
|
-
];
|
|
41
|
-
export default useSelectable;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { type SortDirection, type SortKey } from './use-table';
|
|
2
|
-
export declare const useSorting: <ItemType extends object>(sortKey: SortKey<keyof ItemType>) => {
|
|
3
|
-
sortKey: 'unset' | keyof ItemType;
|
|
4
|
-
sortDirection: SortDirection | undefined;
|
|
5
|
-
setSortState: (key: SortKey<keyof ItemType>) => void;
|
|
6
|
-
sortFn: (rowA: ItemType, rowB: ItemType) => number;
|
|
7
|
-
};
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
export type SortDirection = 'ascending' | 'descending';
|
|
3
|
-
export type SortKey<Key extends string | symbol | number> = Key | 'unset';
|
|
4
|
-
type TableContext<T, K extends keyof T = keyof T> = {
|
|
5
|
-
isSelectable?: boolean;
|
|
6
|
-
sortKey: SortKey<K>;
|
|
7
|
-
sortDirection?: SortDirection;
|
|
8
|
-
sortFn?: (a: T, b: T) => number;
|
|
9
|
-
setSortState: (key: SortKey<K>) => void;
|
|
10
|
-
};
|
|
11
|
-
declare const TableContext: React.Context<TableContext<object, never>>;
|
|
12
|
-
/**
|
|
13
|
-
* __Table state provider__
|
|
14
|
-
*
|
|
15
|
-
* The table context provides the data required for more complex functionality.
|
|
16
|
-
*
|
|
17
|
-
* - [Examples](https://atlassian.design/components/table/examples)
|
|
18
|
-
*/
|
|
19
|
-
export declare function TableProvider<T extends object>({ children, state, }: {
|
|
20
|
-
children: React.ReactNode;
|
|
21
|
-
state: TableContext<T>;
|
|
22
|
-
}): React.JSX.Element;
|
|
23
|
-
export declare const useTable: <TableItem extends object>() => TableContext<TableItem>;
|
|
24
|
-
export {};
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
export { default } from './table';
|
|
2
|
-
export { default as TBody } from './body';
|
|
3
|
-
export { default as Row } from './row';
|
|
4
|
-
export { TD as Cell } from './ui';
|
|
5
|
-
export { default as ExpandableCell } from './expandable-cell';
|
|
6
|
-
export { default as ExpandableRow } from './expandable-row';
|
|
7
|
-
export { default as ExpandableRowContent } from './expandable-row-content';
|
|
8
|
-
export { default as HeadCell } from './head-cell';
|
|
9
|
-
export { default as SortableColumn } from './sortable-column';
|
|
10
|
-
export { default as THead } from './thead';
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
import { type FC, type ReactNode } from 'react';
|
|
2
|
-
type RowProps = {
|
|
3
|
-
/**
|
|
4
|
-
* A `testId` prop is a unique string that appears as a data attribute `data-testid`
|
|
5
|
-
* in the rendered code, serving as a hook for automated tests.
|
|
6
|
-
*/
|
|
7
|
-
testId?: string;
|
|
8
|
-
/**
|
|
9
|
-
* Content of the row.
|
|
10
|
-
*/
|
|
11
|
-
children?: ReactNode;
|
|
12
|
-
};
|
|
13
|
-
/**
|
|
14
|
-
* __Row__
|
|
15
|
-
*
|
|
16
|
-
* A table row.
|
|
17
|
-
*
|
|
18
|
-
* - [Examples](https://atlassian.design/components/table/examples)
|
|
19
|
-
*/
|
|
20
|
-
declare const Row: FC<RowProps>;
|
|
21
|
-
export default Row;
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @jsxRuntime classic
|
|
3
|
-
* @jsx jsx
|
|
4
|
-
*/
|
|
5
|
-
import { type FC, type ReactNode } from 'react';
|
|
6
|
-
interface CellProps {
|
|
7
|
-
/**
|
|
8
|
-
* Unique key used for sorting table data by this column
|
|
9
|
-
*/
|
|
10
|
-
name: string;
|
|
11
|
-
/**
|
|
12
|
-
* A `testId` prop is a unique string that appears as a data attribute `data-testid`
|
|
13
|
-
* in the rendered code, serving as a hook for automated tests.
|
|
14
|
-
*/
|
|
15
|
-
testId?: string;
|
|
16
|
-
onClick?: React.MouseEventHandler;
|
|
17
|
-
children?: ReactNode;
|
|
18
|
-
}
|
|
19
|
-
/**
|
|
20
|
-
* __SortableColumn__
|
|
21
|
-
*
|
|
22
|
-
* SortableColumn is used in place of the default Column when sorting is desired.
|
|
23
|
-
*/
|
|
24
|
-
declare const SortableColumn: FC<CellProps>;
|
|
25
|
-
export default SortableColumn;
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
import React, { type ReactElement } from 'react';
|
|
2
|
-
import { type SortKey } from './hooks/use-table';
|
|
3
|
-
type TableProps<ItemType extends object = {}> = {
|
|
4
|
-
/**
|
|
5
|
-
* A `testId` prop is a unique string that appears as a data attribute `data-testid`
|
|
6
|
-
* in the rendered code, serving as a hook for automated tests.
|
|
7
|
-
*/
|
|
8
|
-
testId?: string;
|
|
9
|
-
/**
|
|
10
|
-
* default sort key to be applied. If unspecified will use default ordering
|
|
11
|
-
*/
|
|
12
|
-
sortKey?: SortKey<keyof ItemType>;
|
|
13
|
-
children: ReactElement[] | ReactElement;
|
|
14
|
-
} & ({
|
|
15
|
-
isSelectable: true;
|
|
16
|
-
defaultSelected?: number;
|
|
17
|
-
} | {
|
|
18
|
-
isSelectable?: false;
|
|
19
|
-
});
|
|
20
|
-
/**
|
|
21
|
-
* __Table__
|
|
22
|
-
*
|
|
23
|
-
* A data table is used to display dynamic data.
|
|
24
|
-
*
|
|
25
|
-
* - [Examples](https://atlassian.design/components/table/examples)
|
|
26
|
-
*/
|
|
27
|
-
declare function Table<ItemType extends object = object>({ children, isSelectable, sortKey, testId, }: TableProps<ItemType>): React.JSX.Element;
|
|
28
|
-
export default Table;
|
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
import React, { type ReactNode } from 'react';
|
|
2
|
-
import { type BoxProps } from '@atlaskit/primitives';
|
|
3
|
-
export type BaseCellProps = {
|
|
4
|
-
/**
|
|
5
|
-
* A percentage of pixel width of the table to apply to a column.
|
|
6
|
-
*/
|
|
7
|
-
width?: string;
|
|
8
|
-
/**
|
|
9
|
-
* Horizontal alignment of content.
|
|
10
|
-
*/
|
|
11
|
-
align?: 'icon' | 'text' | 'number';
|
|
12
|
-
/**
|
|
13
|
-
* Whether the cell should render as a `td` or `th` element.
|
|
14
|
-
*/
|
|
15
|
-
as?: 'td' | 'th';
|
|
16
|
-
/**
|
|
17
|
-
* Same behavior as the HTML attribute.
|
|
18
|
-
*
|
|
19
|
-
* @see 'https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th#attr-scope'
|
|
20
|
-
*/
|
|
21
|
-
scope?: 'col' | 'row';
|
|
22
|
-
/**
|
|
23
|
-
* A `testId` prop is a unique string that appears as a data attribute `data-testid`
|
|
24
|
-
* in the rendered code, serving as a hook for automated tests.
|
|
25
|
-
*/
|
|
26
|
-
testId?: string;
|
|
27
|
-
/**
|
|
28
|
-
* Content of the cell.
|
|
29
|
-
*/
|
|
30
|
-
children?: ReactNode;
|
|
31
|
-
/**
|
|
32
|
-
* Number of columns to span.
|
|
33
|
-
*/
|
|
34
|
-
colSpan?: number;
|
|
35
|
-
/**
|
|
36
|
-
* Number of rows to span.
|
|
37
|
-
*/
|
|
38
|
-
rowSpan?: number;
|
|
39
|
-
} & Pick<BoxProps<any>, 'paddingBlock' | 'paddingInline' | 'backgroundColor' | 'xcss'>;
|
|
40
|
-
/**
|
|
41
|
-
* https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-sort
|
|
42
|
-
*/
|
|
43
|
-
export type SortDirection = 'ascending' | 'descending' | 'none' | 'other';
|
|
44
|
-
type InternalBaseCellProps = BaseCellProps & {
|
|
45
|
-
sortDirection?: SortDirection;
|
|
46
|
-
};
|
|
47
|
-
/**
|
|
48
|
-
* __BaseCell__
|
|
49
|
-
*
|
|
50
|
-
* @internal
|
|
51
|
-
*
|
|
52
|
-
* Basic cell element.
|
|
53
|
-
*/
|
|
54
|
-
export declare const BaseCell: React.ForwardRefExoticComponent<React.PropsWithoutRef<InternalBaseCellProps> & React.RefAttributes<HTMLTableCellElement>>;
|
|
55
|
-
export {};
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
/**
|
|
3
|
-
* __Expand icon__
|
|
4
|
-
*
|
|
5
|
-
* An icon used to display the expanded state in an `<ExpandableCell>`.
|
|
6
|
-
*/
|
|
7
|
-
export declare const ExpandIcon: React.MemoExoticComponent<({ isExpanded }: {
|
|
8
|
-
isExpanded: boolean;
|
|
9
|
-
}) => React.JSX.Element>;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import React, { type ReactNode } from 'react';
|
|
2
|
-
type ExpandableCellProps = {
|
|
3
|
-
as: 'td' | 'th';
|
|
4
|
-
children?: ReactNode;
|
|
5
|
-
};
|
|
6
|
-
/**
|
|
7
|
-
* __Expandable cell__
|
|
8
|
-
*
|
|
9
|
-
* An expandable cell primitive designed to be used for light weight composition.
|
|
10
|
-
*/
|
|
11
|
-
export declare const ExpandableCell: ({ children, as }: ExpandableCellProps) => React.JSX.Element;
|
|
12
|
-
export {};
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* File exposes the HTML table primitives for use
|
|
3
|
-
*/
|
|
4
|
-
export { Table } from './table';
|
|
5
|
-
export { TBody } from './tbody';
|
|
6
|
-
export { TR } from './tr';
|
|
7
|
-
export { TD } from './td';
|
|
8
|
-
export { TH } from './th';
|
|
9
|
-
export { SelectableCell } from './selectable-cell';
|
|
10
|
-
export { ExpandableCell } from './expandable-cell';
|
|
11
|
-
export { ExpandIcon } from './expand-icon';
|
|
12
|
-
export { THead } from './thead';
|
|
13
|
-
export { BulkActionOverlay } from './bulk-action-overlay';
|
|
14
|
-
export { SortIcon } from './sort-icon';
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import React, { type ReactNode } from 'react';
|
|
2
|
-
type SelectableCellProps = {
|
|
3
|
-
as: 'td' | 'th';
|
|
4
|
-
children?: ReactNode;
|
|
5
|
-
};
|
|
6
|
-
/**
|
|
7
|
-
* __Selectable cell__
|
|
8
|
-
*
|
|
9
|
-
* A selectable cell primitive designed to be used for light weight composition.
|
|
10
|
-
*/
|
|
11
|
-
export declare const SelectableCell: ({ children, as }: SelectableCellProps) => React.JSX.Element;
|
|
12
|
-
export {};
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
import { type FC, type ReactNode } from 'react';
|
|
2
|
-
type TableProps = {
|
|
3
|
-
/**
|
|
4
|
-
* A `testId` prop is a unique string that appears as a data attribute `data-testid`
|
|
5
|
-
* in the rendered code, serving as a hook for automated tests.
|
|
6
|
-
*/
|
|
7
|
-
testId?: string;
|
|
8
|
-
/**
|
|
9
|
-
* Accessible description of the table data.
|
|
10
|
-
*
|
|
11
|
-
* @see 'https://www.w3.org/WAI/EO/Drafts/tutorials/tables/summary/'
|
|
12
|
-
*/
|
|
13
|
-
summary?: string;
|
|
14
|
-
/**
|
|
15
|
-
* Table content.
|
|
16
|
-
*/
|
|
17
|
-
children: ReactNode;
|
|
18
|
-
};
|
|
19
|
-
/**
|
|
20
|
-
* __Table__
|
|
21
|
-
*
|
|
22
|
-
* A primitive table container. Applies the HTML native element with no other styling.
|
|
23
|
-
*
|
|
24
|
-
* - [Examples](https://atlassian.design/components/table/examples)
|
|
25
|
-
*
|
|
26
|
-
* @primitive
|
|
27
|
-
* @see https://hello.atlassian.net/wiki/spaces/DST/pages/1947062524/Dynamic+table+2.0+implementation+spec
|
|
28
|
-
*/
|
|
29
|
-
export declare const Table: FC<TableProps>;
|
|
30
|
-
export {};
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { type FC } from 'react';
|
|
2
|
-
import { type BaseCellProps, type SortDirection } from './base-cell';
|
|
3
|
-
export type THProps = Omit<BaseCellProps, 'as'>;
|
|
4
|
-
type InternalTHProps = THProps & {
|
|
5
|
-
sortDirection?: SortDirection;
|
|
6
|
-
};
|
|
7
|
-
/**
|
|
8
|
-
* __Head cell__
|
|
9
|
-
*
|
|
10
|
-
* A head cell.
|
|
11
|
-
*
|
|
12
|
-
* @primitive
|
|
13
|
-
*/
|
|
14
|
-
export declare const TH: FC<InternalTHProps>;
|
|
15
|
-
export {};
|