@instructure/ui-table 10.22.1-snapshot-1 → 10.22.1-snapshot-2

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.
Files changed (10) hide show
  1. package/CHANGELOG.md +1 -1
  2. package/README.md +0 -4
  3. package/es/Table/TableContext.js +13 -1
  4. package/lib/Table/TableContext.js +13 -1
  5. package/package.json +16 -16
  6. package/src/Table/README.md +4 -4
  7. package/src/Table/TableContext.ts +13 -1
  8. package/tsconfig.build.tsbuildinfo +1 -1
  9. package/types/Table/TableContext.d.ts +13 -1
  10. package/types/Table/TableContext.d.ts.map +1 -1
package/types/Table/TableContext.d.ts CHANGED
@@ -15,7 +15,19 @@ type TableContextType = {
15
15
  headers?: Renderable[];
16
16
  };
17
17
  /**
18
- * React context created by the `Table` component to hold its data
18
+ * ---
19
+ * category: utilities/react
20
+ * ---
21
+ * React context created by the `Table` component to hold its data which are
22
+ * read by its children. You can access these to make custom Table cells/rows.
23
+ *
24
+ * It stores the following parameters:
25
+ * - `isStacked`: Whether the `Table` is in `stacked` layout.
26
+ * - `hover`: Whether highlight rows on mouse hover
27
+ * - `headers`: in `stacked` layout the children of the first row of cells
28
+ * (e.g. the titles in a table). This is used in `stacked` layout to display
29
+ * the titles inline
30
+ * @module
19
31
  */
20
32
  declare const TableContext: import("react").Context<TableContextType>;
21
33
  export default TableContext;
package/types/Table/TableContext.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"TableContext.d.ts","sourceRoot":"","sources":["../../src/Table/TableContext.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAEtD,KAAK,gBAAgB,GAAG;IACtB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAA;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,QAAA,MAAM,YAAY,2CAGhB,CAAA;AAEF,eAAe,YAAY,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,CAAA;AACvB,YAAY,EAAE,gBAAgB,EAAE,CAAA"}
1
+ {"version":3,"file":"TableContext.d.ts","sourceRoot":"","sources":["../../src/Table/TableContext.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAEtD,KAAK,gBAAgB,GAAG;IACtB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAA;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAA;CACvB,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,YAAY,2CAGhB,CAAA;AAEF,eAAe,YAAY,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,CAAA;AACvB,YAAY,EAAE,gBAAgB,EAAE,CAAA"}