@instructure/ui-drilldown 11.0.1 → 11.0.2-snapshot-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 +11 -0
- package/es/Drilldown/DrilldownGroup/props.js +1 -1
- package/es/Drilldown/index.js +106 -33
- package/lib/Drilldown/DrilldownGroup/props.js +1 -1
- package/lib/Drilldown/index.js +106 -33
- package/package.json +18 -18
- package/src/Drilldown/DrilldownGroup/props.ts +7 -0
- package/src/Drilldown/index.tsx +116 -34
- package/tsconfig.build.tsbuildinfo +1 -1
- package/types/Drilldown/DrilldownGroup/index.d.ts +1 -0
- package/types/Drilldown/DrilldownGroup/index.d.ts.map +1 -1
- package/types/Drilldown/DrilldownGroup/props.d.ts +5 -0
- package/types/Drilldown/DrilldownGroup/props.d.ts.map +1 -1
- package/types/Drilldown/index.d.ts +22 -2
- package/types/Drilldown/index.d.ts.map +1 -1
|
@@ -20,6 +20,7 @@ declare class DrilldownGroup extends Component<DrilldownGroupProps> {
|
|
|
20
20
|
elementRef?: (element: Element | null) => void;
|
|
21
21
|
selectableType?: "single" | "multiple";
|
|
22
22
|
defaultSelected?: import("../DrilldownOption/props").DrilldownOptionValue[];
|
|
23
|
+
selectedOptions?: import("../DrilldownOption/props").DrilldownOptionValue[];
|
|
23
24
|
onSelect?: (event: React.SyntheticEvent, args: {
|
|
24
25
|
value: import("../DrilldownOption/props").DrilldownOptionValue[];
|
|
25
26
|
isSelected: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Drilldown/DrilldownGroup/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAGlD;;;;;;GAMG;AAGH,cACM,cAAe,SAAQ,SAAS,CAAC,mBAAmB,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,qBAAoB;IAE/C,MAAM,CAAC,YAAY
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Drilldown/DrilldownGroup/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAGlD;;;;;;GAMG;AAGH,cACM,cAAe,SAAQ,SAAS,CAAC,mBAAmB,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,qBAAoB;IAE/C,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;MAMlB;IAED,MAAM;CAKP;AAED,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAA"}
|
|
@@ -45,6 +45,11 @@ type DrilldownGroupOwnProps = {
|
|
|
45
45
|
* An array of the values for the selected items on initial render. Works only with "selectableType" set. If "selectableType" is "single", the array has to have 1 item.
|
|
46
46
|
*/
|
|
47
47
|
defaultSelected?: DrilldownOptionValue[];
|
|
48
|
+
/**
|
|
49
|
+
* An array of the values for the selected items. If defined, the component will act controlled and will not manage its own state. Works only with "selectableType" set.
|
|
50
|
+
* If "selectableType" is "single", the array has to have 1 item.
|
|
51
|
+
*/
|
|
52
|
+
selectedOptions?: DrilldownOptionValue[];
|
|
48
53
|
/**
|
|
49
54
|
* Callback fired when an option within the `<Drilldown.Group />` is selected
|
|
50
55
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Drilldown/DrilldownGroup/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,KAAK,EACV,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACd,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D,OAAO,SAAS,MAAM,UAAU,CAAA;AAChC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAE3D,KAAK,aAAa,GAAG,WAAW,GAAG,cAAc,CAAA;AAEjD,KAAK,sBAAsB,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAA;IAEV;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAA;IAE1C;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAE5D;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAG9C;;;OAGG;IACH,cAAc,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAA;IAEtC;;OAEG;IACH,eAAe,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,CACT,KAAK,EAAE,KAAK,CAAC,cAAc,EAC3B,IAAI,EAAE;QACJ,KAAK,EAAE,oBAAoB,EAAE,CAAA;QAC7B,UAAU,EAAE,OAAO,CAAA;QACnB,cAAc,EAAE,WAAW,CAAA;QAC3B,SAAS,EAAE,SAAS,CAAA;KACrB,KACE,IAAI,CAAA;CACV,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,sBAAsB,CAAA;AAE5C,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,mBAAmB,GAAG,sBAAsB,GAC/C,cAAc,CAAC,YAAY,EAAE,IAAI,CAAC,GAClC,mBAAmB,CAAC,sBAAsB,CAAC,CAAA;AAC7C,QAAA,MAAM,YAAY,EAAE,
|
|
1
|
+
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Drilldown/DrilldownGroup/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,KAAK,EACV,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACd,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D,OAAO,SAAS,MAAM,UAAU,CAAA;AAChC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAE3D,KAAK,aAAa,GAAG,WAAW,GAAG,cAAc,CAAA;AAEjD,KAAK,sBAAsB,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAA;IAEV;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAA;IAE1C;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAE5D;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAG9C;;;OAGG;IACH,cAAc,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAA;IAEtC;;OAEG;IACH,eAAe,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAExC;;;OAGG;IACH,eAAe,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,CACT,KAAK,EAAE,KAAK,CAAC,cAAc,EAC3B,IAAI,EAAE;QACJ,KAAK,EAAE,oBAAoB,EAAE,CAAA;QAC7B,UAAU,EAAE,OAAO,CAAA;QACnB,cAAc,EAAE,WAAW,CAAA;QAC3B,SAAS,EAAE,SAAS,CAAA;KACrB,KACE,IAAI,CAAA;CACV,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,sBAAsB,CAAA;AAE5C,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,mBAAmB,GAAG,sBAAsB,GAC/C,cAAc,CAAC,YAAY,EAAE,IAAI,CAAC,GAClC,mBAAmB,CAAC,sBAAsB,CAAC,CAAA;AAC7C,QAAA,MAAM,YAAY,EAAE,eAanB,CAAA;AAED,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,CAAA"}
|
|
@@ -4,6 +4,7 @@ import { Popover } from '@instructure/ui-popover';
|
|
|
4
4
|
import type { SelectableRender } from '@instructure/ui-selectable';
|
|
5
5
|
import { DrilldownSeparator } from './DrilldownSeparator';
|
|
6
6
|
import { DrilldownOption } from './DrilldownOption';
|
|
7
|
+
import type { DrilldownOptionValue } from './DrilldownOption/props';
|
|
7
8
|
import { DrilldownGroup } from './DrilldownGroup';
|
|
8
9
|
import type { DrilldownGroupProps, GroupChildren } from './DrilldownGroup/props';
|
|
9
10
|
import { DrilldownPage } from './DrilldownPage';
|
|
@@ -64,7 +65,7 @@ declare class Drilldown extends Component<DrilldownProps, DrilldownState> {
|
|
|
64
65
|
} | undefined;
|
|
65
66
|
}) => void;
|
|
66
67
|
onSelect?: (event: React.SyntheticEvent, args: {
|
|
67
|
-
value:
|
|
68
|
+
value: DrilldownOptionValue | DrilldownOptionValue[];
|
|
68
69
|
isSelected: boolean;
|
|
69
70
|
selectedOption: OptionChild;
|
|
70
71
|
drilldown: Drilldown;
|
|
@@ -149,7 +150,26 @@ declare class Drilldown extends Component<DrilldownProps, DrilldownState> {
|
|
|
149
150
|
getChildrenArray<C extends PageChildren | GroupChildren = PageChildren>(children?: C | C[]): C[];
|
|
150
151
|
getPageById(id?: string): MappedPage | undefined;
|
|
151
152
|
getPageChildById(id?: string): MappedOption | undefined;
|
|
152
|
-
|
|
153
|
+
getNormalizedMap(map: Map<string, DrilldownOptionValue>): [string, DrilldownOptionValue][];
|
|
154
|
+
/**
|
|
155
|
+
* Initializes the map of selected options for each group on initial render.
|
|
156
|
+
*
|
|
157
|
+
* This function establishes the selection state based on a clear precedence:
|
|
158
|
+
* 1. **Controlled Mode**: If a `Drilldown.Group` has the `selectedOptions` prop
|
|
159
|
+
* (as an array), it is treated as the absolute source of truth.
|
|
160
|
+
*
|
|
161
|
+
* 2. **Uncontrolled Mode**: If `selectedOptions` is not provided, the selection
|
|
162
|
+
* is determined by `defaultSelected` props, with the following priority:
|
|
163
|
+
* a. The `defaultSelected` boolean on an individual `Drilldown.Option`.
|
|
164
|
+
* b. The `defaultSelected` array of values on the `Drilldown.Group`.
|
|
165
|
+
*
|
|
166
|
+
* It also validates that 'single' selection groups do not mistakenly receive
|
|
167
|
+
* multiple selected or default values.
|
|
168
|
+
*
|
|
169
|
+
* @returns {SelectedGroupOptionsMap} An object where keys are group IDs and
|
|
170
|
+
* values are Maps of the selected { optionId: optionValue } pairs for that group.
|
|
171
|
+
*/
|
|
172
|
+
getSelectedGroupOptionsMap(): SelectedGroupOptionsMap;
|
|
153
173
|
get selectedGroupOptionIdsArray(): string[];
|
|
154
174
|
get headerChildren(): PageChildren[];
|
|
155
175
|
get shown(): boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Drilldown/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAY,SAAS,EAAE,YAAY,EAAa,MAAM,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Drilldown/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAY,SAAS,EAAE,YAAY,EAAa,MAAM,OAAO,CAAA;AAepE,OAAO,KAAK,EACV,YAAY,EAEZ,qBAAqB,EACtB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AAEjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AASlE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAK7E,OAAO,EAAgB,uBAAuB,EAAE,MAAM,SAAS,CAAA;AAE/D,OAAO,KAAK,EACV,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,SAAS,EACT,WAAW,EACX,UAAU,EACV,cAAc,EACf,MAAM,SAAS,CAAA;AAIhB,KAAK,UAAU,GAAG;IAChB,UAAU,CAAC,EAAE,mBAAmB,CAAA;CACjC,CAAA;AAID,KAAK,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAIhE,KAAK,UAAU,GAAG,kBAAkB,GAAG;IACrC,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB,CAAA;AAGD,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;AAEzC;;;;GAIG;AACH,cAEM,SAAU,SAAQ,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC;IAC/D,MAAM,CAAC,QAAQ,CAAC,WAAW,eAAc;IAEzC,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;MAgBlB;IAED,MAAM,CAAC,KAAK,wBAAiB;IAC7B,MAAM,CAAC,MAAM,yBAAkB;IAC/B,MAAM,CAAC,IAAI,uBAAgB;IAC3B,MAAM,CAAC,SAAS,4BAAqB;IAErC,OAAO,CAAC,aAAa,CAA8B;IACnD,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,QAAQ,CAA8D;IAC9E,OAAO,CAAC,iBAAiB,CAA8B;IAEvD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAA;IACpC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAGhC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAU;IAGvC,iBAAiB,EAAE;QACjB,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,CAAA;KACjC,CAAK;IAEN,GAAG,EAAE,cAAc,GAAG,OAAO,GAAG,IAAI,CAAO;IAE3C,SAAS,GAAI,IAAI,cAAc,GAAG,OAAO,GAAG,IAAI,UAS/C;IAED,kBAAkB,GAAI,IAAI,OAAO,GAAG,IAAI,UAcvC;gBAEW,KAAK,EAAE,cAAc;IAsBjC,iBAAiB;IAIjB,kBAAkB,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,cAAc;IAmFxE,IAAI,mBAAmB,IAAI,mBAAmB,CAI7C;IAED,IAAI,eAAe,aAKlB;IAED,IAAI,aAAa,mBAEhB;IAED,IAAI,KAAK,IAAI,SAAS,EAAE,CAGvB;IAED,IAAI,OAAO,IAAI,OAAO,GAAG,SAAS,CAoBjC;IAED,IAAI,YAAY,YAEf;IAED,IAAI,WAAW,IAAI,UAAU,GAAG,SAAS,CAExC;IAED,IAAI,YAAY,IAAI,UAAU,GAAG,SAAS,CAGzC;IAID,IAAI,sBAAsB;;8BAmXI,MAAM;;;;;;;;MAvWnC;IAED,IAAI,oBAAoB,uBAiBvB;IAED,gBAAgB,CAAC,CAAC,SAAS,YAAY,GAAG,aAAa,GAAG,YAAY,EACpE,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE;IAQpB,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIhD,gBAAgB,CAAC,EAAE,CAAC,EAAE,MAAM;IAI5B,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAIvD;;;;;;;;;;;;;;;;;OAiBG;IACH,0BAA0B;IA8E1B,IAAI,2BAA2B,aAI9B;IAED,IAAI,cAAc,mBA8FjB;IAED,IAAI,KAAK,YAER;IAED,sBAAsB,CAAC,QAAQ,EAAE,YAAY,EAAE;IAsB/C,IAAI,GAAI,OAAO,KAAK,CAAC,cAAc,UAKlC;IAED,IAAI,GAAI,OAAO,KAAK,CAAC,cAAc,UAMlC;IAED,KAAK;IAKE,KAAK;IAaL,OAAO;IAQd,WAAW,CAAC,EAAE,EAAE,MAAM;IAStB,qBAAqB,GACnB,QAAQ,KAAK,CAAC,cAAc,EAC5B,mBAAmB;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAA;KAAE,UAsCvD;IAGM,QAAQ,GAAI,WAAW,MAAM;;;kBA4CnC;IAEM,gBAAgB;;;kBActB;IAED,qBAAqB,aASpB;IAED,yBAAyB,CACvB,KAAK,EAAE,KAAK,CAAC,cAAc,EAC3B,cAAc,EAAE,YAAY;IAiE9B,kBAAkB,GAChB,OAAO,KAAK,CAAC,cAAc,EAC3B,QAAQ;QAAE,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,UA4ExB;IAID,aAAa,GAAI,OAAO,KAAK,CAAC,aAAa,UAoC1C;IAED,YAAY,GAAI,OAAO,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,OAAO,OAAO,UAwBtE;IAED,cAAc,gCAgBb;IAED,UAAU,CACR,cAAc,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,EAClD,sBAAsB,EAAE,gBAAgB,CAAC,wBAAwB,CAAC;IAkEpE,eAAe,CAAC,SAAS,EAAE,cAAc;IAczC,YAAY,CACV,MAAM,EAAE,WAAW,EACnB,cAAc,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,EAClD,sBAAsB,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,EAClE,UAAU,CAAC,EAAE,mBAAmB;IAyQlC,WAAW,CACT,KAAK,EAAE,UAAU,EACjB,cAAc,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,EAClD,sBAAsB,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,EAClE,mBAAmB,EAAE,OAAO,EAC5B,kBAAkB,EAAE,OAAO;IAwE7B,UAAU;IA2HV,MAAM;CA2GP;AAED,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA"}
|