@instructure/ui-table 11.7.4-snapshot-102 → 11.7.4-snapshot-103
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 +5 -2
- package/README.md +1 -1
- package/es/Table/v1/index.js +13 -5
- package/es/Table/v2/index.js +3 -7
- package/lib/Table/v1/index.js +13 -5
- package/lib/Table/v2/index.js +3 -7
- package/package.json +14 -14
- package/src/Table/v1/index.tsx +16 -6
- package/src/Table/v1/props.ts +11 -1
- package/src/Table/v2/README.md +16 -8
- package/src/Table/v2/index.tsx +4 -8
- package/src/Table/v2/props.ts +12 -3
- package/tsconfig.build.tsbuildinfo +1 -1
- package/types/Table/v1/index.d.ts +1 -1
- package/types/Table/v1/index.d.ts.map +1 -1
- package/types/Table/v1/props.d.ts +7 -2
- package/types/Table/v1/props.d.ts.map +1 -1
- package/types/Table/v2/index.d.ts +1 -1
- package/types/Table/v2/index.d.ts.map +1 -1
- package/types/Table/v2/props.d.ts +8 -4
- package/types/Table/v2/props.d.ts.map +1 -1
|
@@ -15,7 +15,7 @@ declare class Table extends Component<TableProps> {
|
|
|
15
15
|
static displayName: string;
|
|
16
16
|
static readonly componentId = "Table";
|
|
17
17
|
static allowedProps: readonly (keyof {
|
|
18
|
-
caption: React.ReactNode;
|
|
18
|
+
caption: React.ReactNode | import("./props").TableCaption;
|
|
19
19
|
margin?: import("@instructure/emotion").Spacing;
|
|
20
20
|
elementRef?: (element: Element | null) => void;
|
|
21
21
|
hover?: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Table/v1/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAA0C,MAAM,OAAO,CAAA;AAWzE,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAEtC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAMzC;;;;GAIG;AACH,cACM,KAAM,SAAQ,SAAS,CAAC,UAAU,CAAC;IACvC,MAAM,CAAC,WAAW,SAAU;IAC5B,MAAM,CAAC,QAAQ,CAAC,WAAW,WAAU;IAErC,MAAM,CAAC,YAAY;;;;;;;;SAAe;IAElC,MAAM,CAAC,YAAY;;;;MAIlB;IAED,MAAM,CAAC,IAAI,cAAO;IAClB,MAAM,CAAC,IAAI,cAAO;IAClB,MAAM,CAAC,GAAG,aAAM;IAChB,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,IAAI,cAAO;IAElB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,cAAc,EAAE,cAAc,GAAG,IAAI,CAAO;IAE5C,oBAAoB,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IAEpD,SAAS,GAAI,IAAI,OAAO,GAAG,IAAI,UAG9B;IAED,iBAAiB;IAIjB,kBAAkB,CAAC,SAAS,EAAE,UAAU;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Table/v1/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAA0C,MAAM,OAAO,CAAA;AAWzE,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAEtC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAMzC;;;;GAIG;AACH,cACM,KAAM,SAAQ,SAAS,CAAC,UAAU,CAAC;IACvC,MAAM,CAAC,WAAW,SAAU;IAC5B,MAAM,CAAC,QAAQ,CAAC,WAAW,WAAU;IAErC,MAAM,CAAC,YAAY;;;;;;;;SAAe;IAElC,MAAM,CAAC,YAAY;;;;MAIlB;IAED,MAAM,CAAC,IAAI,cAAO;IAClB,MAAM,CAAC,IAAI,cAAO;IAClB,MAAM,CAAC,GAAG,aAAM;IAChB,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,IAAI,cAAO;IAElB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,cAAc,EAAE,cAAc,GAAG,IAAI,CAAO;IAE5C,oBAAoB,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IAEpD,SAAS,GAAI,IAAI,OAAO,GAAG,IAAI,UAG9B;IAED,iBAAiB;IAIjB,kBAAkB,CAAC,SAAS,EAAE,UAAU;IAmCxC,oBAAoB;IAKpB,UAAU;IAgBV,mBAAmB,CAAC,KAAK,EAAE,UAAU;;;;IA0BrC,cAAc,CAAC,KAAK,EAAE,UAAU;IAWhC,MAAM;CA6DP;AAED,eAAe,KAAK,CAAA;AACpB,OAAO,EAAE,KAAK,EAAE,CAAA"}
|
|
@@ -4,12 +4,17 @@ import type { OtherHTMLAttributes, TableTheme } from '@instructure/shared-types'
|
|
|
4
4
|
type RowChild = React.ReactElement<{
|
|
5
5
|
children: React.ReactElement;
|
|
6
6
|
}>;
|
|
7
|
+
type TableCaption = (sortByHeader: string, sortDirection: 'none' | 'ascending' | 'descending') => string;
|
|
7
8
|
type TableOwnProps = {
|
|
8
9
|
/**
|
|
9
10
|
* Provide a screen reader friendly description. Anything passed to this
|
|
10
11
|
* prop will be wrapped by `<ScreenReaderContent>` when it is rendered.
|
|
12
|
+
*
|
|
13
|
+
* A plain `ReactNode` (e.g. a string) is rendered as-is and the sort state
|
|
14
|
+
* is ignored. Pass a function (see {@link TableCaption}) to build a
|
|
15
|
+
* localized caption that also reflects the current sort state.
|
|
11
16
|
*/
|
|
12
|
-
caption: React.ReactNode;
|
|
17
|
+
caption: React.ReactNode | TableCaption;
|
|
13
18
|
/**
|
|
14
19
|
* Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
|
|
15
20
|
* `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
|
|
@@ -48,6 +53,6 @@ type AllowedPropKeys = Readonly<Array<PropKeys>>;
|
|
|
48
53
|
type TableProps = TableOwnProps & WithStyleProps<TableTheme, TableStyle> & OtherHTMLAttributes<TableOwnProps>;
|
|
49
54
|
type TableStyle = ComponentStyle<'table' | 'liveRegion'>;
|
|
50
55
|
declare const allowedProps: AllowedPropKeys;
|
|
51
|
-
export type { TableProps, TableStyle, RowChild };
|
|
56
|
+
export type { TableProps, TableStyle, TableCaption, RowChild };
|
|
52
57
|
export { allowedProps };
|
|
53
58
|
//# sourceMappingURL=props.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Table/v1/props.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAEhF,KAAK,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC;IAAE,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAA;CAAE,CAAC,CAAA;AAEpE,KAAK,aAAa,GAAG;IACnB
|
|
1
|
+
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Table/v1/props.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAEhF,KAAK,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC;IAAE,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAA;CAAE,CAAC,CAAA;AAEpE,KAAK,YAAY,GAAG,CAClB,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,GAAG,WAAW,GAAG,YAAY,KAC/C,MAAM,CAAA;AAEX,KAAK,aAAa,GAAG;IACnB;;;;;;;OAOG;IACH,OAAO,EAAE,KAAK,CAAC,SAAS,GAAG,YAAY,CAAA;IACvC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;IACrC;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,aAAa,CAAA;AAEnC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,UAAU,GAAG,aAAa,GAC7B,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,GACtC,mBAAmB,CAAC,aAAa,CAAC,CAAA;AAEpC,KAAK,UAAU,GAAG,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,CAAA;AACxD,QAAA,MAAM,YAAY,EAAE,eAOnB,CAAA;AAED,YAAY,EACV,UAAU,EACV,UAAU,EACV,YAAY,EAEZ,QAAQ,EACT,CAAA;AACD,OAAO,EAAE,YAAY,EAAE,CAAA"}
|
|
@@ -15,7 +15,7 @@ declare class Table extends Component<TableProps> {
|
|
|
15
15
|
static displayName: string;
|
|
16
16
|
static readonly componentId = "Table";
|
|
17
17
|
static allowedProps: readonly (keyof {
|
|
18
|
-
caption:
|
|
18
|
+
caption: import("./props").TableCaption;
|
|
19
19
|
margin?: import("@instructure/emotion").Spacing;
|
|
20
20
|
elementRef?: (element: Element | null) => void;
|
|
21
21
|
hover?: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Table/v2/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAA0C,MAAM,OAAO,CAAA;AAUzE,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAEtC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAMzC;;;;GAIG;AACH,cACM,KAAM,SAAQ,SAAS,CAAC,UAAU,CAAC;IACvC,MAAM,CAAC,WAAW,SAAU;IAC5B,MAAM,CAAC,QAAQ,CAAC,WAAW,WAAU;IAErC,MAAM,CAAC,YAAY;;;;;;;;SAAe;IAElC,MAAM,CAAC,YAAY;;;;MAIlB;IAED,MAAM,CAAC,IAAI,cAAO;IAClB,MAAM,CAAC,IAAI,cAAO;IAClB,MAAM,CAAC,GAAG,aAAM;IAChB,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,IAAI,cAAO;IAElB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,cAAc,EAAE,cAAc,GAAG,IAAI,CAAO;IAE5C,oBAAoB,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IAEpD,SAAS,GAAI,IAAI,OAAO,GAAG,IAAI,UAG9B;IAED,iBAAiB;IAIjB,kBAAkB,CAAC,SAAS,EAAE,UAAU;IA4BxC,oBAAoB;IAKpB,UAAU;IAgBV,mBAAmB,CAAC,KAAK,EAAE,UAAU;;;;IA0BrC,cAAc,CAAC,KAAK,EAAE,UAAU;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Table/v2/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAA0C,MAAM,OAAO,CAAA;AAUzE,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAEtC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAMzC;;;;GAIG;AACH,cACM,KAAM,SAAQ,SAAS,CAAC,UAAU,CAAC;IACvC,MAAM,CAAC,WAAW,SAAU;IAC5B,MAAM,CAAC,QAAQ,CAAC,WAAW,WAAU;IAErC,MAAM,CAAC,YAAY;;;;;;;;SAAe;IAElC,MAAM,CAAC,YAAY;;;;MAIlB;IAED,MAAM,CAAC,IAAI,cAAO;IAClB,MAAM,CAAC,IAAI,cAAO;IAClB,MAAM,CAAC,GAAG,aAAM;IAChB,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,IAAI,cAAO;IAElB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,cAAc,EAAE,cAAc,GAAG,IAAI,CAAO;IAE5C,oBAAoB,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IAEpD,SAAS,GAAI,IAAI,OAAO,GAAG,IAAI,UAG9B;IAED,iBAAiB;IAIjB,kBAAkB,CAAC,SAAS,EAAE,UAAU;IA4BxC,oBAAoB;IAKpB,UAAU;IAgBV,mBAAmB,CAAC,KAAK,EAAE,UAAU;;;;IA0BrC,cAAc,CAAC,KAAK,EAAE,UAAU;IAKhC,MAAM;CA4DP;AAED,eAAe,KAAK,CAAA;AACpB,OAAO,EAAE,KAAK,EAAE,CAAA"}
|
|
@@ -5,12 +5,16 @@ import type { NewComponentTypes } from '@instructure/ui-themes';
|
|
|
5
5
|
type RowChild = React.ReactElement<{
|
|
6
6
|
children: React.ReactElement;
|
|
7
7
|
}>;
|
|
8
|
+
type TableCaption = (sortByHeader: string, sortDirection: 'none' | 'ascending' | 'descending') => string;
|
|
8
9
|
type TableOwnProps = {
|
|
9
10
|
/**
|
|
10
|
-
* Provide a screen reader friendly description.
|
|
11
|
-
*
|
|
11
|
+
* Provide a screen reader friendly description. The returned string is
|
|
12
|
+
* wrapped by `<ScreenReaderContent>` when it is rendered.
|
|
13
|
+
*
|
|
14
|
+
* This is a function so consumers can build a localized caption that also
|
|
15
|
+
* reflects the current sort state. See {@link TableCaption}.
|
|
12
16
|
*/
|
|
13
|
-
caption:
|
|
17
|
+
caption: TableCaption;
|
|
14
18
|
/**
|
|
15
19
|
* Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
|
|
16
20
|
* `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
|
|
@@ -49,6 +53,6 @@ type AllowedPropKeys = Readonly<Array<PropKeys>>;
|
|
|
49
53
|
type TableProps = TableOwnProps & WithStyleProps<ReturnType<NewComponentTypes['Table']>, TableStyle> & OtherHTMLAttributes<TableOwnProps>;
|
|
50
54
|
type TableStyle = ComponentStyle<'table' | 'liveRegion'>;
|
|
51
55
|
declare const allowedProps: AllowedPropKeys;
|
|
52
|
-
export type { TableProps, TableStyle, RowChild };
|
|
56
|
+
export type { TableProps, TableStyle, TableCaption, RowChild };
|
|
53
57
|
export { allowedProps };
|
|
54
58
|
//# sourceMappingURL=props.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Table/v2/props.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE/D,KAAK,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC;IAAE,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAA;CAAE,CAAC,CAAA;AAEpE,KAAK,aAAa,GAAG;IACnB
|
|
1
|
+
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Table/v2/props.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE/D,KAAK,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC;IAAE,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAA;CAAE,CAAC,CAAA;AAEpE,KAAK,YAAY,GAAG,CAClB,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,GAAG,WAAW,GAAG,YAAY,KAC/C,MAAM,CAAA;AAEX,KAAK,aAAa,GAAG;IACnB;;;;;;OAMG;IACH,OAAO,EAAE,YAAY,CAAA;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;IACrC;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,aAAa,CAAA;AAEnC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,UAAU,GAAG,aAAa,GAC7B,cAAc,CAAC,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC,GAClE,mBAAmB,CAAC,aAAa,CAAC,CAAA;AAEpC,KAAK,UAAU,GAAG,cAAc,CAAC,OAAO,GAAG,YAAY,CAAC,CAAA;AACxD,QAAA,MAAM,YAAY,EAAE,eAOnB,CAAA;AAED,YAAY,EACV,UAAU,EACV,UAAU,EACV,YAAY,EAEZ,QAAQ,EACT,CAAA;AACD,OAAO,EAAE,YAAY,EAAE,CAAA"}
|