): IDropdownOption[];
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| enumeration | E | |
+| labels | Record<string, string> | (Optional) |
+
+Returns:
+
+IDropdownOption\[\]
+
diff --git a/packages/components/docs/markdown/components.md b/packages/components/docs/markdown/components.md
new file mode 100644
index 00000000..7ae0f5d0
--- /dev/null
+++ b/packages/components/docs/markdown/components.md
@@ -0,0 +1,99 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md)
+
+## components package
+
+## Enumerations
+
+| Enumeration | Description |
+| --- | --- |
+| [CookieConsentCategories](./components.cookieconsentcategories.md) | |
+
+## Functions
+
+| Function | Description |
+| --- | --- |
+| [EnumButtonBar({ enumeration, selected, onChange, styles, iconNames, iconOnly, })](./components.enumbuttonbar.md) | |
+| [getEnumDropdownOptions(enumeration, labels)](./components.getenumdropdownoptions.md) | |
+| [useButtonProps(props, size)](./components.usebuttonprops.md) | |
+| [useCheckboxProps(props, size)](./components.usecheckboxprops.md) | |
+| [useChoiceGroupProps(props, size)](./components.usechoicegroupprops.md) | |
+| [useColorPickerProps(props, size)](./components.usecolorpickerprops.md) | |
+| [useDropdownProps(props, size)](./components.usedropdownprops.md) | |
+| [useIconButtonProps(props, size)](./components.useiconbuttonprops.md) | |
+| [useLabelProps(props, size)](./components.uselabelprops.md) | |
+| [useNavProps(props, size)](./components.usenavprops.md) | |
+| [usePivotProps(props, size)](./components.usepivotprops.md) | |
+| [useSliderProps(props, size)](./components.usesliderprops.md) | |
+| [useSpinButtonProps(props, size)](./components.usespinbuttonprops.md) | |
+| [useTextFieldProps(props, size)](./components.usetextfieldprops.md) | |
+| [useToggleProps(props, size)](./components.usetoggleprops.md) | |
+
+## Interfaces
+
+| Interface | Description |
+| --- | --- |
+| [ClippedGraphProps](./components.clippedgraphprops.md) | |
+| [CollapsiblePanelContainerProps](./components.collapsiblepanelcontainerprops.md) | The container that will have multiple CollapsiblePanel as children, passing the last and first params automatically. |
+| [CollapsiblePanelProps](./components.collapsiblepanelprops.md) | Props for the CollapsiblePanel |
+| [CollapsiblePanelStyles](./components.collapsiblepanelstyles.md) | |
+| [ColumnarMenuProps](./components.columnarmenuprops.md) | |
+| [ControlledHistogramFilterProps](./components.controlledhistogramfilterprops.md) | |
+| [EnumButtonBarProps](./components.enumbuttonbarprops.md) | |
+| [EnumDropdownProps](./components.enumdropdownprops.md) | |
+| [ExpandoProps](./components.expandoprops.md) | |
+| [ExpandoStyles](./components.expandostyles.md) | |
+| [FilterTextboxProps](./components.filtertextboxprops.md) | |
+| [MultiDropdownProps](./components.multidropdownprops.md) | |
+| [NumberSpinButtonProps](./components.numberspinbuttonprops.md) | |
+| [SearchBoxProps](./components.searchboxprops.md) | |
+| [SettingsGroup](./components.settingsgroup.md) | |
+| [SettingsProps](./components.settingsprops.md) | |
+| [Sized](./components.sized.md) | |
+| [ToggleLinkProps](./components.togglelinkprops.md) | |
+| [ToolPanelProps](./components.toolpanelprops.md) | |
+| [ToolPanelStyles](./components.toolpanelstyles.md) | |
+| [TreeGroup](./components.treegroup.md) | Defines groups available in a Tree. Individual TreeItems can use their group field to be sorted into known groups. |
+| [TreeGroupProps](./components.treegroupprops.md) | |
+| [TreeItem](./components.treeitem.md) | |
+| [TreeItemProps](./components.treeitemprops.md) | |
+| [TreeProps](./components.treeprops.md) | |
+| [TreePropsBase](./components.treepropsbase.md) | |
+
+## Variables
+
+| Variable | Description |
+| --- | --- |
+| [ButtonChoiceGroup](./components.buttonchoicegroup.md) | ButtonChoiceGroup is a ChoiceGroup component that renders as buttons instead of radios. |
+| [ClippedGraph](./components.clippedgraph.md) | Creates a line chart that handles extreme distributions with a few clipping/wrapping strategies. The "clipped graph" concept was presented by Haihan Lin at VIS2019. https://vdl.sci.utah.edu/publications/2019\_infovis\_clipped\_graphs/ This chart can also produce a horizon plot, or be formatted to look like a sparkline. For examples of these variants, see the visual sandbox: https://visualsandbox.azurewebsites.net/\#/experiments/clipped-graphs |
+| [CollapsiblePanel](./components.collapsiblepanel.md) | CollapsiblePanel displays a Header and its child that collapse and expands with keyboard arrows, space, enter or onclick showing the 'hidden' rendering |
+| [CollapsiblePanelContainer](./components.collapsiblepanelcontainer.md) | Receives an array of CollapsiblePanel as children to render it with first and last props calculating it automatically |
+| [ColumnarMenu](./components.columnarmenu.md) | Dropdown button menu that supports grouped items (using sectionProps) in a columnar layout. This is a hybrid control that uses a button to create the dropdown menu, but overrides the menu renderer to lay out any item sections as columns instead of a vertical stack. |
+| [ColumnarMenuList](./components.columnarmenulist.md) | This component replaces the default ContextualMenuList rendering with a columnar layout of the sections instead of vertical stacks. Note that items should be sorted into sections with sectionProps, though options buttons do not need to be in a section and will all be coalesced at the top. |
+| [ControlledHistogramFilter](./components.controlledhistogramfilter.md) | ControlledHistogramFilter displays a histogram that contains a D3 brush and basic numberical filtering with thematic theming |
+| [defaultBannerLinks](./components.defaultbannerlinks.md) | |
+| [DialogConfirm](./components.dialogconfirm.md) | |
+| [EnumDropdown](./components.enumdropdown.md) | Dropdown wrapper to list out aggregation operations. |
+| [Expando](./components.expando.md) | Toggle link with a chevron and show/hide of children. |
+| [FilterTextbox](./components.filtertextbox.md) | This component presents a compound textbox filter that includes an inline toggle button to switch between inclusion and exclusion of the filter text. To use this component, ensure that Fluent is bootstrapped to include loaded icons See https://developer.microsoft.com/en-us/fluentui\#/styles/web/icons |
+| [MultiDropdown](./components.multidropdown.md) | Dropdown wrapper to manage multi-select with a select all/none helper. |
+| [NumberSpinButton](./components.numberspinbutton.md) | NumberSpinButton creates a thematic styled SpinButton from Fluent |
+| [PolicyAndCookieBanner](./components.policyandcookiebanner.md) | |
+| [ReadOnlyTextField](./components.readonlytextfield.md) | This is a standard TextField, with default styles overridden to provide some consistent "read only look" that visually indicates the field can't be edited without looking fully disabled. |
+| [SearchBox](./components.searchbox.md) | Extends the idea of a SearchBox to include the Search button alongside the text field. Note that this is a compound TextField + PrimaryButton. We may want to switch the the Fluent SearchBox field, which includes autocomplete capability. |
+| [Settings](./components.settings.md) | A zero-config settings panel that parses a supplied object and generates a list of Fluent UI controls based on the data types. A config object can be supplied that maps specific object fields to more detailed control config, such as changing between a Toggle or Checkbox. In addition, it will invoke a onChange handler for any setting, supplying the changed setting's key and new value. Note that this could be used in an entirely declarative/serializable manner if desired. |
+| [ToggleLink](./components.togglelink.md) | Presents a hyperlink that toggles between two messages, like a toggle button. |
+| [ToolPanel](./components.toolpanel.md) | |
+| [Tree](./components.tree.md) | |
+
+## Type Aliases
+
+| Type Alias | Description |
+| --- | --- |
+| [CookieConsent](./components.cookieconsent.md) | Record of approved and blocked cookie types.
Record<"Required" \| "Analytics" \| "SocialMedia" \| "Advertising", boolean>
|
+| [CookieConsentBannerThemes](./components.cookieconsentbannerthemes.md) | Theme of the cookie consent banner popup that is managed by the wcp script. This sets the theme for the popup only and does not impact the theme of the policy footer or links. The policy footer uses FluentUI so it should pick up the theme from parent FluentUI theme provider. |
+| [PolicyAndCookieBannerProps](./components.policyandcookiebannerprops.md) | Defaults to { language: navigator.language ?? 'en-US' theme: 'light', onConsentChange: () => void, links: \[ { name: 'Privacy & Cookies', href: ' https://go.microsoft.com/fwlink/?LinkId=521839', }, { name: 'Terms of Use', href: 'https://go.microsoft.com/fwlink/?LinkID=760869', }, { name: 'Trademarks', href: 'https://www.microsoft.com/en-us/legal/intellectualproperty/Trademarks/EN-US.aspx', }, { name: 'Contact Us', href: 'https://go.microsoft.com/?linkid=2028325', }, { name: 'Code of Conduct', href: 'https://opensource.microsoft.com/codeofconduct/', }, { name: ©️ ${new Date().getFullYear()} Microsoft, href: 'https://www.microsoft.com/en-us/legal/intellectualproperty/copyright', }, \] } |
+| [PolicyLinkDetails](./components.policylinkdetails.md) | |
+| [Size](./components.size.md) | |
+
diff --git a/packages/components/docs/markdown/components.multidropdown.md b/packages/components/docs/markdown/components.multidropdown.md
new file mode 100644
index 00000000..003d5c78
--- /dev/null
+++ b/packages/components/docs/markdown/components.multidropdown.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [MultiDropdown](./components.multidropdown.md)
+
+## MultiDropdown variable
+
+Dropdown wrapper to manage multi-select with a select all/none helper.
+
+Signature:
+
+```typescript
+MultiDropdown: React.FC
+```
diff --git a/packages/components/docs/markdown/components.multidropdownprops.md b/packages/components/docs/markdown/components.multidropdownprops.md
new file mode 100644
index 00000000..27b69aa2
--- /dev/null
+++ b/packages/components/docs/markdown/components.multidropdownprops.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [MultiDropdownProps](./components.multidropdownprops.md)
+
+## MultiDropdownProps interface
+
+Signature:
+
+```typescript
+export interface MultiDropdownProps extends IDropdownProps
+```
+Extends: IDropdownProps
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [onChangeAll?](./components.multidropdownprops.onchangeall.md) | | (event: React.MouseEvent<HTMLAnchorElement \| HTMLButtonElement \| HTMLElement>, options?: IDropdownOption\[\], indexes?: number\[\]) => void | (Optional) |
+
diff --git a/packages/components/docs/markdown/components.multidropdownprops.onchangeall.md b/packages/components/docs/markdown/components.multidropdownprops.onchangeall.md
new file mode 100644
index 00000000..609c6c5b
--- /dev/null
+++ b/packages/components/docs/markdown/components.multidropdownprops.onchangeall.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [MultiDropdownProps](./components.multidropdownprops.md) > [onChangeAll](./components.multidropdownprops.onchangeall.md)
+
+## MultiDropdownProps.onChangeAll property
+
+Signature:
+
+```typescript
+onChangeAll?: (event: React.MouseEvent, options?: IDropdownOption[], indexes?: number[]) => void;
+```
diff --git a/packages/components/docs/markdown/components.numberspinbutton.md b/packages/components/docs/markdown/components.numberspinbutton.md
new file mode 100644
index 00000000..55e84fbd
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbutton.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButton](./components.numberspinbutton.md)
+
+## NumberSpinButton variable
+
+NumberSpinButton creates a thematic styled SpinButton from Fluent
+
+Signature:
+
+```typescript
+NumberSpinButton: ({ label, value, min, max, step, onChange, labelPosition, incrementButtonAriaLabel, decrementButtonAriaLabel, }: NumberSpinButtonProps) => JSX.Element
+```
diff --git a/packages/components/docs/markdown/components.numberspinbuttonprops.decrementbuttonarialabel.md b/packages/components/docs/markdown/components.numberspinbuttonprops.decrementbuttonarialabel.md
new file mode 100644
index 00000000..a4fcea6e
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbuttonprops.decrementbuttonarialabel.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButtonProps](./components.numberspinbuttonprops.md) > [decrementButtonAriaLabel](./components.numberspinbuttonprops.decrementbuttonarialabel.md)
+
+## NumberSpinButtonProps.decrementButtonAriaLabel property
+
+Signature:
+
+```typescript
+decrementButtonAriaLabel?: string;
+```
diff --git a/packages/components/docs/markdown/components.numberspinbuttonprops.incrementbuttonarialabel.md b/packages/components/docs/markdown/components.numberspinbuttonprops.incrementbuttonarialabel.md
new file mode 100644
index 00000000..856acc30
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbuttonprops.incrementbuttonarialabel.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButtonProps](./components.numberspinbuttonprops.md) > [incrementButtonAriaLabel](./components.numberspinbuttonprops.incrementbuttonarialabel.md)
+
+## NumberSpinButtonProps.incrementButtonAriaLabel property
+
+Signature:
+
+```typescript
+incrementButtonAriaLabel?: string;
+```
diff --git a/packages/components/docs/markdown/components.numberspinbuttonprops.label.md b/packages/components/docs/markdown/components.numberspinbuttonprops.label.md
new file mode 100644
index 00000000..31ece6bc
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbuttonprops.label.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButtonProps](./components.numberspinbuttonprops.md) > [label](./components.numberspinbuttonprops.label.md)
+
+## NumberSpinButtonProps.label property
+
+Signature:
+
+```typescript
+label: string;
+```
diff --git a/packages/components/docs/markdown/components.numberspinbuttonprops.labelposition.md b/packages/components/docs/markdown/components.numberspinbuttonprops.labelposition.md
new file mode 100644
index 00000000..2158d84e
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbuttonprops.labelposition.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButtonProps](./components.numberspinbuttonprops.md) > [labelPosition](./components.numberspinbuttonprops.labelposition.md)
+
+## NumberSpinButtonProps.labelPosition property
+
+Signature:
+
+```typescript
+labelPosition?: Position;
+```
diff --git a/packages/components/docs/markdown/components.numberspinbuttonprops.max.md b/packages/components/docs/markdown/components.numberspinbuttonprops.max.md
new file mode 100644
index 00000000..67a19067
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbuttonprops.max.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButtonProps](./components.numberspinbuttonprops.md) > [max](./components.numberspinbuttonprops.max.md)
+
+## NumberSpinButtonProps.max property
+
+Signature:
+
+```typescript
+max?: number;
+```
diff --git a/packages/components/docs/markdown/components.numberspinbuttonprops.md b/packages/components/docs/markdown/components.numberspinbuttonprops.md
new file mode 100644
index 00000000..2a399d28
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbuttonprops.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButtonProps](./components.numberspinbuttonprops.md)
+
+## NumberSpinButtonProps interface
+
+Signature:
+
+```typescript
+export interface NumberSpinButtonProps
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [decrementButtonAriaLabel?](./components.numberspinbuttonprops.decrementbuttonarialabel.md) | | string | (Optional) |
+| [incrementButtonAriaLabel?](./components.numberspinbuttonprops.incrementbuttonarialabel.md) | | string | (Optional) |
+| [label](./components.numberspinbuttonprops.label.md) | | string | |
+| [labelPosition?](./components.numberspinbuttonprops.labelposition.md) | | Position | (Optional) |
+| [max?](./components.numberspinbuttonprops.max.md) | | number | (Optional) |
+| [min?](./components.numberspinbuttonprops.min.md) | | number | (Optional) |
+| [onChange?](./components.numberspinbuttonprops.onchange.md) | | (n: number) => any | (Optional) |
+| [step?](./components.numberspinbuttonprops.step.md) | | number | (Optional) |
+| [value](./components.numberspinbuttonprops.value.md) | | number | |
+
diff --git a/packages/components/docs/markdown/components.numberspinbuttonprops.min.md b/packages/components/docs/markdown/components.numberspinbuttonprops.min.md
new file mode 100644
index 00000000..3c4a13d5
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbuttonprops.min.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButtonProps](./components.numberspinbuttonprops.md) > [min](./components.numberspinbuttonprops.min.md)
+
+## NumberSpinButtonProps.min property
+
+Signature:
+
+```typescript
+min?: number;
+```
diff --git a/packages/components/docs/markdown/components.numberspinbuttonprops.onchange.md b/packages/components/docs/markdown/components.numberspinbuttonprops.onchange.md
new file mode 100644
index 00000000..7682a88e
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbuttonprops.onchange.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButtonProps](./components.numberspinbuttonprops.md) > [onChange](./components.numberspinbuttonprops.onchange.md)
+
+## NumberSpinButtonProps.onChange property
+
+Signature:
+
+```typescript
+onChange?: (n: number) => any;
+```
diff --git a/packages/components/docs/markdown/components.numberspinbuttonprops.step.md b/packages/components/docs/markdown/components.numberspinbuttonprops.step.md
new file mode 100644
index 00000000..da4b7601
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbuttonprops.step.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButtonProps](./components.numberspinbuttonprops.md) > [step](./components.numberspinbuttonprops.step.md)
+
+## NumberSpinButtonProps.step property
+
+Signature:
+
+```typescript
+step?: number;
+```
diff --git a/packages/components/docs/markdown/components.numberspinbuttonprops.value.md b/packages/components/docs/markdown/components.numberspinbuttonprops.value.md
new file mode 100644
index 00000000..b36c6279
--- /dev/null
+++ b/packages/components/docs/markdown/components.numberspinbuttonprops.value.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [NumberSpinButtonProps](./components.numberspinbuttonprops.md) > [value](./components.numberspinbuttonprops.value.md)
+
+## NumberSpinButtonProps.value property
+
+Signature:
+
+```typescript
+value: number;
+```
diff --git a/packages/components/docs/markdown/components.policyandcookiebanner.md b/packages/components/docs/markdown/components.policyandcookiebanner.md
new file mode 100644
index 00000000..b3925778
--- /dev/null
+++ b/packages/components/docs/markdown/components.policyandcookiebanner.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [PolicyAndCookieBanner](./components.policyandcookiebanner.md)
+
+## PolicyAndCookieBanner variable
+
+Signature:
+
+```typescript
+PolicyAndCookieBanner: FC
+```
diff --git a/packages/components/docs/markdown/components.policyandcookiebannerprops.md b/packages/components/docs/markdown/components.policyandcookiebannerprops.md
new file mode 100644
index 00000000..d781af9c
--- /dev/null
+++ b/packages/components/docs/markdown/components.policyandcookiebannerprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [PolicyAndCookieBannerProps](./components.policyandcookiebannerprops.md)
+
+## PolicyAndCookieBannerProps type
+
+Defaults to { language: navigator.language ?? 'en-US' theme: 'light', onConsentChange: () => void, links: \[ { name: 'Privacy & Cookies', href: ' https://go.microsoft.com/fwlink/?LinkId=521839', }, { name: 'Terms of Use', href: 'https://go.microsoft.com/fwlink/?LinkID=760869', }, { name: 'Trademarks', href: 'https://www.microsoft.com/en-us/legal/intellectualproperty/Trademarks/EN-US.aspx', }, { name: 'Contact Us', href: 'https://go.microsoft.com/?linkid=2028325', }, { name: 'Code of Conduct', href: 'https://opensource.microsoft.com/codeofconduct/', }, { name: `©️ ${new Date().getFullYear()} Microsoft`, href: 'https://www.microsoft.com/en-us/legal/intellectualproperty/copyright', }, \] }
+
+Signature:
+
+```typescript
+export type PolicyAndCookieBannerProps = {
+ language?: string;
+ theme?: CookieConsentBannerThemes;
+ onConsentChange?: (newConsent: CookieConsent) => void;
+ onError: (error: unknown) => void;
+ className?: string;
+ styles?: CSSProperties;
+ links?: Array;
+};
+```
+References: [CookieConsentBannerThemes](./components.cookieconsentbannerthemes.md), [CookieConsent](./components.cookieconsent.md), [PolicyLinkDetails](./components.policylinkdetails.md)
+
diff --git a/packages/components/docs/markdown/components.policylinkdetails.md b/packages/components/docs/markdown/components.policylinkdetails.md
new file mode 100644
index 00000000..92b2ff45
--- /dev/null
+++ b/packages/components/docs/markdown/components.policylinkdetails.md
@@ -0,0 +1,15 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [PolicyLinkDetails](./components.policylinkdetails.md)
+
+## PolicyLinkDetails type
+
+
+Signature:
+
+```typescript
+export type PolicyLinkDetails = {
+ name: string;
+ href: string;
+};
+```
diff --git a/packages/components/docs/markdown/components.readonlytextfield.md b/packages/components/docs/markdown/components.readonlytextfield.md
new file mode 100644
index 00000000..8b63dedd
--- /dev/null
+++ b/packages/components/docs/markdown/components.readonlytextfield.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ReadOnlyTextField](./components.readonlytextfield.md)
+
+## ReadOnlyTextField variable
+
+This is a standard TextField, with default styles overridden to provide some consistent "read only look" that visually indicates the field can't be edited without looking fully disabled.
+
+Signature:
+
+```typescript
+ReadOnlyTextField: React.FC
+```
diff --git a/packages/components/docs/markdown/components.searchbox.md b/packages/components/docs/markdown/components.searchbox.md
new file mode 100644
index 00000000..c0bf5784
--- /dev/null
+++ b/packages/components/docs/markdown/components.searchbox.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SearchBox](./components.searchbox.md)
+
+## SearchBox variable
+
+Extends the idea of a SearchBox to include the Search button alongside the text field. Note that this is a compound TextField + PrimaryButton. We may want to switch the the Fluent SearchBox field, which includes autocomplete capability.
+
+Signature:
+
+```typescript
+SearchBox: ({ defaultValue, label, placeholder, errorMessage, onSearch, }: SearchBoxProps) => JSX.Element
+```
diff --git a/packages/components/docs/markdown/components.searchboxprops.defaultvalue.md b/packages/components/docs/markdown/components.searchboxprops.defaultvalue.md
new file mode 100644
index 00000000..7ed06d7b
--- /dev/null
+++ b/packages/components/docs/markdown/components.searchboxprops.defaultvalue.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SearchBoxProps](./components.searchboxprops.md) > [defaultValue](./components.searchboxprops.defaultvalue.md)
+
+## SearchBoxProps.defaultValue property
+
+Value to display in the box on initial display.
+
+Signature:
+
+```typescript
+defaultValue?: string;
+```
diff --git a/packages/components/docs/markdown/components.searchboxprops.errormessage.md b/packages/components/docs/markdown/components.searchboxprops.errormessage.md
new file mode 100644
index 00000000..dd602827
--- /dev/null
+++ b/packages/components/docs/markdown/components.searchboxprops.errormessage.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SearchBoxProps](./components.searchboxprops.md) > [errorMessage](./components.searchboxprops.errormessage.md)
+
+## SearchBoxProps.errorMessage property
+
+Error message to display below the text field when applicable.
+
+Signature:
+
+```typescript
+errorMessage?: string;
+```
diff --git a/packages/components/docs/markdown/components.searchboxprops.label.md b/packages/components/docs/markdown/components.searchboxprops.label.md
new file mode 100644
index 00000000..15031ab1
--- /dev/null
+++ b/packages/components/docs/markdown/components.searchboxprops.label.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SearchBoxProps](./components.searchboxprops.md) > [label](./components.searchboxprops.label.md)
+
+## SearchBoxProps.label property
+
+Label above the search box.
+
+Signature:
+
+```typescript
+label?: string;
+```
diff --git a/packages/components/docs/markdown/components.searchboxprops.md b/packages/components/docs/markdown/components.searchboxprops.md
new file mode 100644
index 00000000..fa82f4d8
--- /dev/null
+++ b/packages/components/docs/markdown/components.searchboxprops.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SearchBoxProps](./components.searchboxprops.md)
+
+## SearchBoxProps interface
+
+Signature:
+
+```typescript
+export interface SearchBoxProps
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [defaultValue?](./components.searchboxprops.defaultvalue.md) | | string | (Optional) Value to display in the box on initial display. |
+| [errorMessage?](./components.searchboxprops.errormessage.md) | | string | (Optional) Error message to display below the text field when applicable. |
+| [label?](./components.searchboxprops.label.md) | | string | (Optional) Label above the search box. |
+| [onSearch?](./components.searchboxprops.onsearch.md) | | (query: string) => any | (Optional) Callback to receive query text when the user presses enter or clicks the search button. |
+| [placeholder?](./components.searchboxprops.placeholder.md) | | string | (Optional) Placeholder text for the empty text field. |
+
diff --git a/packages/components/docs/markdown/components.searchboxprops.onsearch.md b/packages/components/docs/markdown/components.searchboxprops.onsearch.md
new file mode 100644
index 00000000..41cb8df2
--- /dev/null
+++ b/packages/components/docs/markdown/components.searchboxprops.onsearch.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SearchBoxProps](./components.searchboxprops.md) > [onSearch](./components.searchboxprops.onsearch.md)
+
+## SearchBoxProps.onSearch property
+
+Callback to receive query text when the user presses enter or clicks the search button.
+
+Signature:
+
+```typescript
+onSearch?: (query: string) => any;
+```
diff --git a/packages/components/docs/markdown/components.searchboxprops.placeholder.md b/packages/components/docs/markdown/components.searchboxprops.placeholder.md
new file mode 100644
index 00000000..9df5cba3
--- /dev/null
+++ b/packages/components/docs/markdown/components.searchboxprops.placeholder.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SearchBoxProps](./components.searchboxprops.md) > [placeholder](./components.searchboxprops.placeholder.md)
+
+## SearchBoxProps.placeholder property
+
+Placeholder text for the empty text field.
+
+Signature:
+
+```typescript
+placeholder?: string;
+```
diff --git a/packages/components/docs/markdown/components.settings.md b/packages/components/docs/markdown/components.settings.md
new file mode 100644
index 00000000..417ab742
--- /dev/null
+++ b/packages/components/docs/markdown/components.settings.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [Settings](./components.settings.md)
+
+## Settings variable
+
+A zero-config settings panel that parses a supplied object and generates a list of Fluent UI controls based on the data types. A config object can be supplied that maps specific object fields to more detailed control config, such as changing between a Toggle or Checkbox. In addition, it will invoke a onChange handler for any setting, supplying the changed setting's key and new value. Note that this could be used in an entirely declarative/serializable manner if desired.
+
+Signature:
+
+```typescript
+Settings: ({ settings, config, groups, onChange, }: SettingsProps) => JSX.Element
+```
diff --git a/packages/components/docs/markdown/components.settingsgroup.keys.md b/packages/components/docs/markdown/components.settingsgroup.keys.md
new file mode 100644
index 00000000..1d7462fc
--- /dev/null
+++ b/packages/components/docs/markdown/components.settingsgroup.keys.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SettingsGroup](./components.settingsgroup.md) > [keys](./components.settingsgroup.keys.md)
+
+## SettingsGroup.keys property
+
+Signature:
+
+```typescript
+keys: string[];
+```
diff --git a/packages/components/docs/markdown/components.settingsgroup.label.md b/packages/components/docs/markdown/components.settingsgroup.label.md
new file mode 100644
index 00000000..6e4c2fde
--- /dev/null
+++ b/packages/components/docs/markdown/components.settingsgroup.label.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SettingsGroup](./components.settingsgroup.md) > [label](./components.settingsgroup.label.md)
+
+## SettingsGroup.label property
+
+Signature:
+
+```typescript
+label?: string;
+```
diff --git a/packages/components/docs/markdown/components.settingsgroup.md b/packages/components/docs/markdown/components.settingsgroup.md
new file mode 100644
index 00000000..1bd6aeb7
--- /dev/null
+++ b/packages/components/docs/markdown/components.settingsgroup.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SettingsGroup](./components.settingsgroup.md)
+
+## SettingsGroup interface
+
+Signature:
+
+```typescript
+export interface SettingsGroup
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [keys](./components.settingsgroup.keys.md) | | string\[\] | |
+| [label?](./components.settingsgroup.label.md) | | string | (Optional) |
+
diff --git a/packages/components/docs/markdown/components.settingsprops.config.md b/packages/components/docs/markdown/components.settingsprops.config.md
new file mode 100644
index 00000000..b6965bc5
--- /dev/null
+++ b/packages/components/docs/markdown/components.settingsprops.config.md
@@ -0,0 +1,15 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SettingsProps](./components.settingsprops.md) > [config](./components.settingsprops.config.md)
+
+## SettingsProps.config property
+
+Map of optional config params for individual settings. The key should match the key present in the settings object.
+
+Signature:
+
+```typescript
+config?: {
+ [key: string]: SettingConfig;
+ };
+```
diff --git a/packages/components/docs/markdown/components.settingsprops.groups.md b/packages/components/docs/markdown/components.settingsprops.groups.md
new file mode 100644
index 00000000..d35f0d39
--- /dev/null
+++ b/packages/components/docs/markdown/components.settingsprops.groups.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SettingsProps](./components.settingsprops.md) > [groups](./components.settingsprops.groups.md)
+
+## SettingsProps.groups property
+
+List of optional groups to sort the settings into, with a separator between each. The group is a list of the keys to include, with an optional label for the separator.
+
+Signature:
+
+```typescript
+groups?: SettingsGroup[];
+```
diff --git a/packages/components/docs/markdown/components.settingsprops.md b/packages/components/docs/markdown/components.settingsprops.md
new file mode 100644
index 00000000..34c469d6
--- /dev/null
+++ b/packages/components/docs/markdown/components.settingsprops.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SettingsProps](./components.settingsprops.md)
+
+## SettingsProps interface
+
+Signature:
+
+```typescript
+export interface SettingsProps
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [config?](./components.settingsprops.config.md) | | { \[key: string\]: SettingConfig; } | (Optional) Map of optional config params for individual settings. The key should match the key present in the settings object. |
+| [groups?](./components.settingsprops.groups.md) | | [SettingsGroup](./components.settingsgroup.md)\[\] | (Optional) List of optional groups to sort the settings into, with a separator between each. The group is a list of the keys to include, with an optional label for the separator. |
+| [onChange?](./components.settingsprops.onchange.md) | | (key: string, value: any) => void | (Optional) Handler to notify when any of the settings has changed. Callback args will be the key and value that changed. Merging, etc. is up to the consumer. |
+| [settings](./components.settingsprops.settings.md) | | any | Required object to render into a settings panel. This can be basically anything, but should be flat at the moment, as complex/nest objects are not supported. |
+
diff --git a/packages/components/docs/markdown/components.settingsprops.onchange.md b/packages/components/docs/markdown/components.settingsprops.onchange.md
new file mode 100644
index 00000000..3d06c2e2
--- /dev/null
+++ b/packages/components/docs/markdown/components.settingsprops.onchange.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SettingsProps](./components.settingsprops.md) > [onChange](./components.settingsprops.onchange.md)
+
+## SettingsProps.onChange property
+
+Handler to notify when any of the settings has changed. Callback args will be the key and value that changed. Merging, etc. is up to the consumer.
+
+Signature:
+
+```typescript
+onChange?: (key: string, value: any) => void;
+```
diff --git a/packages/components/docs/markdown/components.settingsprops.settings.md b/packages/components/docs/markdown/components.settingsprops.settings.md
new file mode 100644
index 00000000..2218b31a
--- /dev/null
+++ b/packages/components/docs/markdown/components.settingsprops.settings.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [SettingsProps](./components.settingsprops.md) > [settings](./components.settingsprops.settings.md)
+
+## SettingsProps.settings property
+
+Required object to render into a settings panel. This can be basically anything, but should be flat at the moment, as complex/nest objects are not supported.
+
+Signature:
+
+```typescript
+settings: any;
+```
diff --git a/packages/components/docs/markdown/components.size.md b/packages/components/docs/markdown/components.size.md
new file mode 100644
index 00000000..90721066
--- /dev/null
+++ b/packages/components/docs/markdown/components.size.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [Size](./components.size.md)
+
+## Size type
+
+Signature:
+
+```typescript
+export type Size = 'small' | 'medium';
+```
diff --git a/packages/components/docs/markdown/components.sized.md b/packages/components/docs/markdown/components.sized.md
new file mode 100644
index 00000000..b7564289
--- /dev/null
+++ b/packages/components/docs/markdown/components.sized.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [Sized](./components.sized.md)
+
+## Sized interface
+
+Signature:
+
+```typescript
+export interface Sized
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [size?](./components.sized.size.md) | | [Size](./components.size.md) | (Optional) |
+
diff --git a/packages/components/docs/markdown/components.sized.size.md b/packages/components/docs/markdown/components.sized.size.md
new file mode 100644
index 00000000..67c00272
--- /dev/null
+++ b/packages/components/docs/markdown/components.sized.size.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [Sized](./components.sized.md) > [size](./components.sized.size.md)
+
+## Sized.size property
+
+Signature:
+
+```typescript
+size?: Size;
+```
diff --git a/packages/components/docs/markdown/components.togglelink.md b/packages/components/docs/markdown/components.togglelink.md
new file mode 100644
index 00000000..d9ffe83a
--- /dev/null
+++ b/packages/components/docs/markdown/components.togglelink.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToggleLink](./components.togglelink.md)
+
+## ToggleLink variable
+
+Presents a hyperlink that toggles between two messages, like a toggle button.
+
+Signature:
+
+```typescript
+ToggleLink: React.FC
+```
diff --git a/packages/components/docs/markdown/components.togglelinkprops.classname.md b/packages/components/docs/markdown/components.togglelinkprops.classname.md
new file mode 100644
index 00000000..35652a7f
--- /dev/null
+++ b/packages/components/docs/markdown/components.togglelinkprops.classname.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToggleLinkProps](./components.togglelinkprops.md) > [className](./components.togglelinkprops.classname.md)
+
+## ToggleLinkProps.className property
+
+Signature:
+
+```typescript
+className?: string;
+```
diff --git a/packages/components/docs/markdown/components.togglelinkprops.md b/packages/components/docs/markdown/components.togglelinkprops.md
new file mode 100644
index 00000000..b924b5a7
--- /dev/null
+++ b/packages/components/docs/markdown/components.togglelinkprops.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToggleLinkProps](./components.togglelinkprops.md)
+
+## ToggleLinkProps interface
+
+Signature:
+
+```typescript
+export interface ToggleLinkProps
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [className?](./components.togglelinkprops.classname.md) | | string | (Optional) |
+| [messages](./components.togglelinkprops.messages.md) | | \[string, string\] | |
+| [onChange?](./components.togglelinkprops.onchange.md) | | (toggled: boolean) => void | (Optional) |
+| [style?](./components.togglelinkprops.style.md) | | React.CSSProperties | (Optional) |
+
diff --git a/packages/components/docs/markdown/components.togglelinkprops.messages.md b/packages/components/docs/markdown/components.togglelinkprops.messages.md
new file mode 100644
index 00000000..e3f6db1f
--- /dev/null
+++ b/packages/components/docs/markdown/components.togglelinkprops.messages.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToggleLinkProps](./components.togglelinkprops.md) > [messages](./components.togglelinkprops.messages.md)
+
+## ToggleLinkProps.messages property
+
+Signature:
+
+```typescript
+messages: [string, string];
+```
diff --git a/packages/components/docs/markdown/components.togglelinkprops.onchange.md b/packages/components/docs/markdown/components.togglelinkprops.onchange.md
new file mode 100644
index 00000000..005c5f8e
--- /dev/null
+++ b/packages/components/docs/markdown/components.togglelinkprops.onchange.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToggleLinkProps](./components.togglelinkprops.md) > [onChange](./components.togglelinkprops.onchange.md)
+
+## ToggleLinkProps.onChange property
+
+Signature:
+
+```typescript
+onChange?: (toggled: boolean) => void;
+```
diff --git a/packages/components/docs/markdown/components.togglelinkprops.style.md b/packages/components/docs/markdown/components.togglelinkprops.style.md
new file mode 100644
index 00000000..acf2e75b
--- /dev/null
+++ b/packages/components/docs/markdown/components.togglelinkprops.style.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToggleLinkProps](./components.togglelinkprops.md) > [style](./components.togglelinkprops.style.md)
+
+## ToggleLinkProps.style property
+
+Signature:
+
+```typescript
+style?: React.CSSProperties;
+```
diff --git a/packages/components/docs/markdown/components.toolpanel.md b/packages/components/docs/markdown/components.toolpanel.md
new file mode 100644
index 00000000..6b39d046
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanel.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanel](./components.toolpanel.md)
+
+## ToolPanel variable
+
+Signature:
+
+```typescript
+ToolPanel: React.FC>
+```
diff --git a/packages/components/docs/markdown/components.toolpanelprops.closeiconprops.md b/packages/components/docs/markdown/components.toolpanelprops.closeiconprops.md
new file mode 100644
index 00000000..fca87584
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelprops.closeiconprops.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelProps](./components.toolpanelprops.md) > [closeIconProps](./components.toolpanelprops.closeiconprops.md)
+
+## ToolPanelProps.closeIconProps property
+
+Signature:
+
+```typescript
+closeIconProps?: IIconProps;
+```
diff --git a/packages/components/docs/markdown/components.toolpanelprops.hasclosebutton.md b/packages/components/docs/markdown/components.toolpanelprops.hasclosebutton.md
new file mode 100644
index 00000000..679bc8c1
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelprops.hasclosebutton.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelProps](./components.toolpanelprops.md) > [hasCloseButton](./components.toolpanelprops.hasclosebutton.md)
+
+## ToolPanelProps.hasCloseButton property
+
+Signature:
+
+```typescript
+hasCloseButton?: boolean;
+```
diff --git a/packages/components/docs/markdown/components.toolpanelprops.headericonprops.md b/packages/components/docs/markdown/components.toolpanelprops.headericonprops.md
new file mode 100644
index 00000000..3312ba79
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelprops.headericonprops.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelProps](./components.toolpanelprops.md) > [headerIconProps](./components.toolpanelprops.headericonprops.md)
+
+## ToolPanelProps.headerIconProps property
+
+Signature:
+
+```typescript
+headerIconProps?: IIconProps;
+```
diff --git a/packages/components/docs/markdown/components.toolpanelprops.headertext.md b/packages/components/docs/markdown/components.toolpanelprops.headertext.md
new file mode 100644
index 00000000..104f7f34
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelprops.headertext.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelProps](./components.toolpanelprops.md) > [headerText](./components.toolpanelprops.headertext.md)
+
+## ToolPanelProps.headerText property
+
+Signature:
+
+```typescript
+headerText?: string;
+```
diff --git a/packages/components/docs/markdown/components.toolpanelprops.md b/packages/components/docs/markdown/components.toolpanelprops.md
new file mode 100644
index 00000000..9a66c6de
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelProps](./components.toolpanelprops.md)
+
+## ToolPanelProps interface
+
+Signature:
+
+```typescript
+export interface ToolPanelProps
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [closeIconProps?](./components.toolpanelprops.closeiconprops.md) | | IIconProps | (Optional) |
+| [hasCloseButton?](./components.toolpanelprops.hasclosebutton.md) | | boolean | (Optional) |
+| [headerIconProps?](./components.toolpanelprops.headericonprops.md) | | IIconProps | (Optional) |
+| [headerText?](./components.toolpanelprops.headertext.md) | | string | (Optional) |
+| [onDismiss?](./components.toolpanelprops.ondismiss.md) | | () => void | (Optional) |
+| [styles?](./components.toolpanelprops.styles.md) | | [ToolPanelStyles](./components.toolpanelstyles.md) | (Optional) |
+
diff --git a/packages/components/docs/markdown/components.toolpanelprops.ondismiss.md b/packages/components/docs/markdown/components.toolpanelprops.ondismiss.md
new file mode 100644
index 00000000..4d3af40a
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelprops.ondismiss.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelProps](./components.toolpanelprops.md) > [onDismiss](./components.toolpanelprops.ondismiss.md)
+
+## ToolPanelProps.onDismiss property
+
+Signature:
+
+```typescript
+onDismiss?: () => void;
+```
diff --git a/packages/components/docs/markdown/components.toolpanelprops.styles.md b/packages/components/docs/markdown/components.toolpanelprops.styles.md
new file mode 100644
index 00000000..64ca7c3b
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelprops.styles.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelProps](./components.toolpanelprops.md) > [styles](./components.toolpanelprops.styles.md)
+
+## ToolPanelProps.styles property
+
+Signature:
+
+```typescript
+styles?: ToolPanelStyles;
+```
diff --git a/packages/components/docs/markdown/components.toolpanelstyles.content.md b/packages/components/docs/markdown/components.toolpanelstyles.content.md
new file mode 100644
index 00000000..eb1060ea
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelstyles.content.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelStyles](./components.toolpanelstyles.md) > [content](./components.toolpanelstyles.content.md)
+
+## ToolPanelStyles.content property
+
+Signature:
+
+```typescript
+content?: React.CSSProperties;
+```
diff --git a/packages/components/docs/markdown/components.toolpanelstyles.header.md b/packages/components/docs/markdown/components.toolpanelstyles.header.md
new file mode 100644
index 00000000..c06e3e43
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelstyles.header.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelStyles](./components.toolpanelstyles.md) > [header](./components.toolpanelstyles.header.md)
+
+## ToolPanelStyles.header property
+
+Signature:
+
+```typescript
+header?: React.CSSProperties;
+```
diff --git a/packages/components/docs/markdown/components.toolpanelstyles.md b/packages/components/docs/markdown/components.toolpanelstyles.md
new file mode 100644
index 00000000..97d4e996
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelstyles.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelStyles](./components.toolpanelstyles.md)
+
+## ToolPanelStyles interface
+
+Signature:
+
+```typescript
+export interface ToolPanelStyles
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [content?](./components.toolpanelstyles.content.md) | | React.CSSProperties | (Optional) |
+| [header?](./components.toolpanelstyles.header.md) | | React.CSSProperties | (Optional) |
+| [root?](./components.toolpanelstyles.root.md) | | React.CSSProperties | (Optional) |
+| [title?](./components.toolpanelstyles.title.md) | | React.CSSProperties | (Optional) |
+| [titleContainer?](./components.toolpanelstyles.titlecontainer.md) | | React.CSSProperties | (Optional) |
+
diff --git a/packages/components/docs/markdown/components.toolpanelstyles.root.md b/packages/components/docs/markdown/components.toolpanelstyles.root.md
new file mode 100644
index 00000000..b4452fa5
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelstyles.root.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelStyles](./components.toolpanelstyles.md) > [root](./components.toolpanelstyles.root.md)
+
+## ToolPanelStyles.root property
+
+Signature:
+
+```typescript
+root?: React.CSSProperties;
+```
diff --git a/packages/components/docs/markdown/components.toolpanelstyles.title.md b/packages/components/docs/markdown/components.toolpanelstyles.title.md
new file mode 100644
index 00000000..ba346f20
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelstyles.title.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelStyles](./components.toolpanelstyles.md) > [title](./components.toolpanelstyles.title.md)
+
+## ToolPanelStyles.title property
+
+Signature:
+
+```typescript
+title?: React.CSSProperties;
+```
diff --git a/packages/components/docs/markdown/components.toolpanelstyles.titlecontainer.md b/packages/components/docs/markdown/components.toolpanelstyles.titlecontainer.md
new file mode 100644
index 00000000..c98388da
--- /dev/null
+++ b/packages/components/docs/markdown/components.toolpanelstyles.titlecontainer.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [ToolPanelStyles](./components.toolpanelstyles.md) > [titleContainer](./components.toolpanelstyles.titlecontainer.md)
+
+## ToolPanelStyles.titleContainer property
+
+Signature:
+
+```typescript
+titleContainer?: React.CSSProperties;
+```
diff --git a/packages/components/docs/markdown/components.tree.md b/packages/components/docs/markdown/components.tree.md
new file mode 100644
index 00000000..4f810c24
--- /dev/null
+++ b/packages/components/docs/markdown/components.tree.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [Tree](./components.tree.md)
+
+## Tree variable
+
+Signature:
+
+```typescript
+Tree: React.FC
+```
diff --git a/packages/components/docs/markdown/components.treegroup.key.md b/packages/components/docs/markdown/components.treegroup.key.md
new file mode 100644
index 00000000..caf2d580
--- /dev/null
+++ b/packages/components/docs/markdown/components.treegroup.key.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeGroup](./components.treegroup.md) > [key](./components.treegroup.key.md)
+
+## TreeGroup.key property
+
+Signature:
+
+```typescript
+key: string;
+```
diff --git a/packages/components/docs/markdown/components.treegroup.md b/packages/components/docs/markdown/components.treegroup.md
new file mode 100644
index 00000000..98b00a78
--- /dev/null
+++ b/packages/components/docs/markdown/components.treegroup.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeGroup](./components.treegroup.md)
+
+## TreeGroup interface
+
+Defines groups available in a Tree. Individual TreeItems can use their group field to be sorted into known groups.
+
+Signature:
+
+```typescript
+export interface TreeGroup
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [key](./components.treegroup.key.md) | | string | |
+| [text?](./components.treegroup.text.md) | | string | (Optional) |
+
diff --git a/packages/components/docs/markdown/components.treegroup.text.md b/packages/components/docs/markdown/components.treegroup.text.md
new file mode 100644
index 00000000..9804e19e
--- /dev/null
+++ b/packages/components/docs/markdown/components.treegroup.text.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeGroup](./components.treegroup.md) > [text](./components.treegroup.text.md)
+
+## TreeGroup.text property
+
+Signature:
+
+```typescript
+text?: string;
+```
diff --git a/packages/components/docs/markdown/components.treegroupprops.group.md b/packages/components/docs/markdown/components.treegroupprops.group.md
new file mode 100644
index 00000000..8d0cf88c
--- /dev/null
+++ b/packages/components/docs/markdown/components.treegroupprops.group.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeGroupProps](./components.treegroupprops.md) > [group](./components.treegroupprops.group.md)
+
+## TreeGroupProps.group property
+
+Signature:
+
+```typescript
+group: TreeGroup;
+```
diff --git a/packages/components/docs/markdown/components.treegroupprops.md b/packages/components/docs/markdown/components.treegroupprops.md
new file mode 100644
index 00000000..ae7b6624
--- /dev/null
+++ b/packages/components/docs/markdown/components.treegroupprops.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeGroupProps](./components.treegroupprops.md)
+
+## TreeGroupProps interface
+
+Signature:
+
+```typescript
+export interface TreeGroupProps
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [group](./components.treegroupprops.group.md) | | [TreeGroup](./components.treegroup.md) | |
+| [onRenderGroupHeader?](./components.treegroupprops.onrendergroupheader.md) | | IRenderFunction<[TreeGroupProps](./components.treegroupprops.md)> | (Optional) |
+| [size?](./components.treegroupprops.size.md) | | [Size](./components.size.md) | (Optional) |
+| [styles?](./components.treegroupprops.styles.md) | | TreeStyles | (Optional) |
+
diff --git a/packages/components/docs/markdown/components.treegroupprops.onrendergroupheader.md b/packages/components/docs/markdown/components.treegroupprops.onrendergroupheader.md
new file mode 100644
index 00000000..bcc893eb
--- /dev/null
+++ b/packages/components/docs/markdown/components.treegroupprops.onrendergroupheader.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeGroupProps](./components.treegroupprops.md) > [onRenderGroupHeader](./components.treegroupprops.onrendergroupheader.md)
+
+## TreeGroupProps.onRenderGroupHeader property
+
+Signature:
+
+```typescript
+onRenderGroupHeader?: IRenderFunction;
+```
diff --git a/packages/components/docs/markdown/components.treegroupprops.size.md b/packages/components/docs/markdown/components.treegroupprops.size.md
new file mode 100644
index 00000000..c11972e9
--- /dev/null
+++ b/packages/components/docs/markdown/components.treegroupprops.size.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeGroupProps](./components.treegroupprops.md) > [size](./components.treegroupprops.size.md)
+
+## TreeGroupProps.size property
+
+Signature:
+
+```typescript
+size?: Size;
+```
diff --git a/packages/components/docs/markdown/components.treegroupprops.styles.md b/packages/components/docs/markdown/components.treegroupprops.styles.md
new file mode 100644
index 00000000..8e354f72
--- /dev/null
+++ b/packages/components/docs/markdown/components.treegroupprops.styles.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeGroupProps](./components.treegroupprops.md) > [styles](./components.treegroupprops.styles.md)
+
+## TreeGroupProps.styles property
+
+Signature:
+
+```typescript
+styles?: TreeStyles;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.children.md b/packages/components/docs/markdown/components.treeitem.children.md
new file mode 100644
index 00000000..a754455b
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.children.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [children](./components.treeitem.children.md)
+
+## TreeItem.children property
+
+Child TreeItems to recursively render.
+
+Signature:
+
+```typescript
+children?: TreeItem[];
+```
diff --git a/packages/components/docs/markdown/components.treeitem.depth.md b/packages/components/docs/markdown/components.treeitem.depth.md
new file mode 100644
index 00000000..63a45695
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.depth.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [depth](./components.treeitem.depth.md)
+
+## TreeItem.depth property
+
+Depth of the item, which affects its left position for hierarchical rendering.
+
+Signature:
+
+```typescript
+depth?: number;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.expanded.md b/packages/components/docs/markdown/components.treeitem.expanded.md
new file mode 100644
index 00000000..06f4a622
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.expanded.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [expanded](./components.treeitem.expanded.md)
+
+## TreeItem.expanded property
+
+Indicates the item is expanded and should display child items and content.
+
+Signature:
+
+```typescript
+expanded?: boolean;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.group.md b/packages/components/docs/markdown/components.treeitem.group.md
new file mode 100644
index 00000000..0a7c4e46
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.group.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [group](./components.treeitem.group.md)
+
+## TreeItem.group property
+
+Key of the group this item belongs to, if groups are specified.
+
+Signature:
+
+```typescript
+group?: string;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.iconname.md b/packages/components/docs/markdown/components.treeitem.iconname.md
new file mode 100644
index 00000000..9c9944cd
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.iconname.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [iconName](./components.treeitem.iconname.md)
+
+## TreeItem.iconName property
+
+Optional icon to show before the text.
+
+Signature:
+
+```typescript
+iconName?: string;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.key.md b/packages/components/docs/markdown/components.treeitem.key.md
new file mode 100644
index 00000000..8617c2a7
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.key.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [key](./components.treeitem.key.md)
+
+## TreeItem.key property
+
+Signature:
+
+```typescript
+key: string;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.md b/packages/components/docs/markdown/components.treeitem.md
new file mode 100644
index 00000000..95188dfa
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.md
@@ -0,0 +1,30 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md)
+
+## TreeItem interface
+
+Signature:
+
+```typescript
+export interface TreeItem
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [children?](./components.treeitem.children.md) | | [TreeItem](./components.treeitem.md)\[\] | (Optional) Child TreeItems to recursively render. |
+| [depth?](./components.treeitem.depth.md) | | number | (Optional) Depth of the item, which affects its left position for hierarchical rendering. |
+| [expanded?](./components.treeitem.expanded.md) | | boolean | (Optional) Indicates the item is expanded and should display child items and content. |
+| [group?](./components.treeitem.group.md) | | string | (Optional) Key of the group this item belongs to, if groups are specified. |
+| [iconName?](./components.treeitem.iconname.md) | | string | (Optional) Optional icon to show before the text. |
+| [key](./components.treeitem.key.md) | | string | |
+| [menuItems?](./components.treeitem.menuitems.md) | | IContextualMenuItem\[\] | (Optional) List of menu items to display in a right-side dropdown menu. |
+| [onClick?](./components.treeitem.onclick.md) | | (item: [TreeItem](./components.treeitem.md)) => void | (Optional) Individual click handler for this item. Will suppress top-level onItemClick if set. |
+| [onExpand?](./components.treeitem.onexpand.md) | | (item: [TreeItem](./components.treeitem.md)) => void | (Optional) Individual click handler for this item's expand/collapse icon. Will suppress top-level onItemExpandClick if set. |
+| [onRenderContent?](./components.treeitem.onrendercontent.md) | | IRenderFunction<[TreeItemProps](./components.treeitemprops.md)> | (Optional) Render function for the child content of the item, including child nodes. |
+| [onRenderTitle?](./components.treeitem.onrendertitle.md) | | IRenderFunction<[TreeItemProps](./components.treeitemprops.md)> | (Optional) Render function for the title content of the item. Includes the content \*between\* the expand/collapse button and the menu items. |
+| [selected?](./components.treeitem.selected.md) | | boolean | (Optional) Indicates the item is selected and should be styled as such. |
+| [text?](./components.treeitem.text.md) | | string | (Optional) |
+
diff --git a/packages/components/docs/markdown/components.treeitem.menuitems.md b/packages/components/docs/markdown/components.treeitem.menuitems.md
new file mode 100644
index 00000000..c5f7f03d
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.menuitems.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [menuItems](./components.treeitem.menuitems.md)
+
+## TreeItem.menuItems property
+
+List of menu items to display in a right-side dropdown menu.
+
+Signature:
+
+```typescript
+menuItems?: IContextualMenuItem[];
+```
diff --git a/packages/components/docs/markdown/components.treeitem.onclick.md b/packages/components/docs/markdown/components.treeitem.onclick.md
new file mode 100644
index 00000000..afdfeb5c
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.onclick.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [onClick](./components.treeitem.onclick.md)
+
+## TreeItem.onClick property
+
+Individual click handler for this item. Will suppress top-level onItemClick if set.
+
+Signature:
+
+```typescript
+onClick?: (item: TreeItem) => void;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.onexpand.md b/packages/components/docs/markdown/components.treeitem.onexpand.md
new file mode 100644
index 00000000..34a3229d
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.onexpand.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [onExpand](./components.treeitem.onexpand.md)
+
+## TreeItem.onExpand property
+
+Individual click handler for this item's expand/collapse icon. Will suppress top-level onItemExpandClick if set.
+
+Signature:
+
+```typescript
+onExpand?: (item: TreeItem) => void;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.onrendercontent.md b/packages/components/docs/markdown/components.treeitem.onrendercontent.md
new file mode 100644
index 00000000..d45037fe
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.onrendercontent.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [onRenderContent](./components.treeitem.onrendercontent.md)
+
+## TreeItem.onRenderContent property
+
+Render function for the child content of the item, including child nodes.
+
+Signature:
+
+```typescript
+onRenderContent?: IRenderFunction;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.onrendertitle.md b/packages/components/docs/markdown/components.treeitem.onrendertitle.md
new file mode 100644
index 00000000..7db8b79e
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.onrendertitle.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [onRenderTitle](./components.treeitem.onrendertitle.md)
+
+## TreeItem.onRenderTitle property
+
+Render function for the title content of the item. Includes the content \*between\* the expand/collapse button and the menu items.
+
+Signature:
+
+```typescript
+onRenderTitle?: IRenderFunction;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.selected.md b/packages/components/docs/markdown/components.treeitem.selected.md
new file mode 100644
index 00000000..d365bc5f
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.selected.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [selected](./components.treeitem.selected.md)
+
+## TreeItem.selected property
+
+Indicates the item is selected and should be styled as such.
+
+Signature:
+
+```typescript
+selected?: boolean;
+```
diff --git a/packages/components/docs/markdown/components.treeitem.text.md b/packages/components/docs/markdown/components.treeitem.text.md
new file mode 100644
index 00000000..c98d43d1
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitem.text.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItem](./components.treeitem.md) > [text](./components.treeitem.text.md)
+
+## TreeItem.text property
+
+Signature:
+
+```typescript
+text?: string;
+```
diff --git a/packages/components/docs/markdown/components.treeitemprops.item.md b/packages/components/docs/markdown/components.treeitemprops.item.md
new file mode 100644
index 00000000..867efa2f
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitemprops.item.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItemProps](./components.treeitemprops.md) > [item](./components.treeitemprops.item.md)
+
+## TreeItemProps.item property
+
+Signature:
+
+```typescript
+item: TreeItem;
+```
diff --git a/packages/components/docs/markdown/components.treeitemprops.md b/packages/components/docs/markdown/components.treeitemprops.md
new file mode 100644
index 00000000..81e3a98d
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeitemprops.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeItemProps](./components.treeitemprops.md)
+
+## TreeItemProps interface
+
+Signature:
+
+```typescript
+export interface TreeItemProps extends TreePropsBase
+```
+Extends: [TreePropsBase](./components.treepropsbase.md)
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [item](./components.treeitemprops.item.md) | | [TreeItem](./components.treeitem.md) | |
+
diff --git a/packages/components/docs/markdown/components.treeprops.groups.md b/packages/components/docs/markdown/components.treeprops.groups.md
new file mode 100644
index 00000000..b901ea6f
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeprops.groups.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeProps](./components.treeprops.md) > [groups](./components.treeprops.groups.md)
+
+## TreeProps.groups property
+
+Optional group definitions. If groups are defined, each root item must have a group key.
+
+Signature:
+
+```typescript
+groups?: TreeGroup[];
+```
diff --git a/packages/components/docs/markdown/components.treeprops.items.md b/packages/components/docs/markdown/components.treeprops.items.md
new file mode 100644
index 00000000..ca39343f
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeprops.items.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeProps](./components.treeprops.md) > [items](./components.treeprops.items.md)
+
+## TreeProps.items property
+
+List of items to render in the tree.
+
+Signature:
+
+```typescript
+items: TreeItem[];
+```
diff --git a/packages/components/docs/markdown/components.treeprops.md b/packages/components/docs/markdown/components.treeprops.md
new file mode 100644
index 00000000..ddeaf061
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeprops.md
@@ -0,0 +1,24 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeProps](./components.treeprops.md)
+
+## TreeProps interface
+
+Signature:
+
+```typescript
+export interface TreeProps extends TreePropsBase
+```
+Extends: [TreePropsBase](./components.treepropsbase.md)
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [groups?](./components.treeprops.groups.md) | | [TreeGroup](./components.treegroup.md)\[\] | (Optional) Optional group definitions. If groups are defined, each root item must have a group key. |
+| [items](./components.treeprops.items.md) | | [TreeItem](./components.treeitem.md)\[\] | List of items to render in the tree. |
+| [onItemClick?](./components.treeprops.onitemclick.md) | | (item: [TreeItem](./components.treeitem.md)) => void | (Optional) Global handler for individual item clicks. |
+| [onItemExpandClick?](./components.treeprops.onitemexpandclick.md) | | (item: [TreeItem](./components.treeitem.md)) => void | (Optional) Global handler for individual expand/collapse icon clicks. |
+| [onRenderGroupHeader?](./components.treeprops.onrendergroupheader.md) | | IRenderFunction<[TreeGroupProps](./components.treegroupprops.md)> | (Optional) Render function to override the group header. |
+| [selectedKey?](./components.treeprops.selectedkey.md) | | string | (Optional) Selected item in the tree. |
+
diff --git a/packages/components/docs/markdown/components.treeprops.onitemclick.md b/packages/components/docs/markdown/components.treeprops.onitemclick.md
new file mode 100644
index 00000000..c8499fae
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeprops.onitemclick.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeProps](./components.treeprops.md) > [onItemClick](./components.treeprops.onitemclick.md)
+
+## TreeProps.onItemClick property
+
+Global handler for individual item clicks.
+
+Signature:
+
+```typescript
+onItemClick?: (item: TreeItem) => void;
+```
diff --git a/packages/components/docs/markdown/components.treeprops.onitemexpandclick.md b/packages/components/docs/markdown/components.treeprops.onitemexpandclick.md
new file mode 100644
index 00000000..f0ed8b5d
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeprops.onitemexpandclick.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeProps](./components.treeprops.md) > [onItemExpandClick](./components.treeprops.onitemexpandclick.md)
+
+## TreeProps.onItemExpandClick property
+
+Global handler for individual expand/collapse icon clicks.
+
+Signature:
+
+```typescript
+onItemExpandClick?: (item: TreeItem) => void;
+```
diff --git a/packages/components/docs/markdown/components.treeprops.onrendergroupheader.md b/packages/components/docs/markdown/components.treeprops.onrendergroupheader.md
new file mode 100644
index 00000000..a515ea68
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeprops.onrendergroupheader.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeProps](./components.treeprops.md) > [onRenderGroupHeader](./components.treeprops.onrendergroupheader.md)
+
+## TreeProps.onRenderGroupHeader property
+
+Render function to override the group header.
+
+Signature:
+
+```typescript
+onRenderGroupHeader?: IRenderFunction;
+```
diff --git a/packages/components/docs/markdown/components.treeprops.selectedkey.md b/packages/components/docs/markdown/components.treeprops.selectedkey.md
new file mode 100644
index 00000000..2c2b8b9a
--- /dev/null
+++ b/packages/components/docs/markdown/components.treeprops.selectedkey.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreeProps](./components.treeprops.md) > [selectedKey](./components.treeprops.selectedkey.md)
+
+## TreeProps.selectedKey property
+
+Selected item in the tree.
+
+Signature:
+
+```typescript
+selectedKey?: string;
+```
diff --git a/packages/components/docs/markdown/components.treepropsbase.contentbuttonprops.md b/packages/components/docs/markdown/components.treepropsbase.contentbuttonprops.md
new file mode 100644
index 00000000..f9f9740a
--- /dev/null
+++ b/packages/components/docs/markdown/components.treepropsbase.contentbuttonprops.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreePropsBase](./components.treepropsbase.md) > [contentButtonProps](./components.treepropsbase.contentbuttonprops.md)
+
+## TreePropsBase.contentButtonProps property
+
+Override props for the main button used to render each tree item's content. Note that this includes the iconProps if you want to customize how the item's icon (if any) looks.
+
+Signature:
+
+```typescript
+contentButtonProps?: IButtonProps;
+```
diff --git a/packages/components/docs/markdown/components.treepropsbase.expandbuttonprops.md b/packages/components/docs/markdown/components.treepropsbase.expandbuttonprops.md
new file mode 100644
index 00000000..5c904e57
--- /dev/null
+++ b/packages/components/docs/markdown/components.treepropsbase.expandbuttonprops.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreePropsBase](./components.treepropsbase.md) > [expandButtonProps](./components.treepropsbase.expandbuttonprops.md)
+
+## TreePropsBase.expandButtonProps property
+
+Override props to customize the expand/collapse button (including its styles).
+
+Signature:
+
+```typescript
+expandButtonProps?: ExpandIconButtonProps;
+```
diff --git a/packages/components/docs/markdown/components.treepropsbase.md b/packages/components/docs/markdown/components.treepropsbase.md
new file mode 100644
index 00000000..20ca9d08
--- /dev/null
+++ b/packages/components/docs/markdown/components.treepropsbase.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreePropsBase](./components.treepropsbase.md)
+
+## TreePropsBase interface
+
+Signature:
+
+```typescript
+export interface TreePropsBase
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [contentButtonProps?](./components.treepropsbase.contentbuttonprops.md) | | IButtonProps | (Optional) Override props for the main button used to render each tree item's content. Note that this includes the iconProps if you want to customize how the item's icon (if any) looks. |
+| [expandButtonProps?](./components.treepropsbase.expandbuttonprops.md) | | ExpandIconButtonProps | (Optional) Override props to customize the expand/collapse button (including its styles). |
+| [menuButtonProps?](./components.treepropsbase.menubuttonprops.md) | | MenuButtonProps | (Optional) Override props for the right-side menu item for each item (if they have menuItems). |
+| [narrow?](./components.treepropsbase.narrow.md) | | boolean | (Optional) Indicates that the Tree should be rendered in a narrow mode |
+| [size?](./components.treepropsbase.size.md) | | [Size](./components.size.md) | (Optional) Set the size mode of the tree |
+| [styles?](./components.treepropsbase.styles.md) | | TreeStyles | (Optional) General styles for customizing the tree. |
+
diff --git a/packages/components/docs/markdown/components.treepropsbase.menubuttonprops.md b/packages/components/docs/markdown/components.treepropsbase.menubuttonprops.md
new file mode 100644
index 00000000..ea3cb2f7
--- /dev/null
+++ b/packages/components/docs/markdown/components.treepropsbase.menubuttonprops.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreePropsBase](./components.treepropsbase.md) > [menuButtonProps](./components.treepropsbase.menubuttonprops.md)
+
+## TreePropsBase.menuButtonProps property
+
+Override props for the right-side menu item for each item (if they have menuItems).
+
+Signature:
+
+```typescript
+menuButtonProps?: MenuButtonProps;
+```
diff --git a/packages/components/docs/markdown/components.treepropsbase.narrow.md b/packages/components/docs/markdown/components.treepropsbase.narrow.md
new file mode 100644
index 00000000..62f0d993
--- /dev/null
+++ b/packages/components/docs/markdown/components.treepropsbase.narrow.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreePropsBase](./components.treepropsbase.md) > [narrow](./components.treepropsbase.narrow.md)
+
+## TreePropsBase.narrow property
+
+Indicates that the Tree should be rendered in a narrow mode
+
+Signature:
+
+```typescript
+narrow?: boolean;
+```
diff --git a/packages/components/docs/markdown/components.treepropsbase.size.md b/packages/components/docs/markdown/components.treepropsbase.size.md
new file mode 100644
index 00000000..10cc25d3
--- /dev/null
+++ b/packages/components/docs/markdown/components.treepropsbase.size.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreePropsBase](./components.treepropsbase.md) > [size](./components.treepropsbase.size.md)
+
+## TreePropsBase.size property
+
+Set the size mode of the tree
+
+Signature:
+
+```typescript
+size?: Size;
+```
diff --git a/packages/components/docs/markdown/components.treepropsbase.styles.md b/packages/components/docs/markdown/components.treepropsbase.styles.md
new file mode 100644
index 00000000..8b8c5a3f
--- /dev/null
+++ b/packages/components/docs/markdown/components.treepropsbase.styles.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [TreePropsBase](./components.treepropsbase.md) > [styles](./components.treepropsbase.styles.md)
+
+## TreePropsBase.styles property
+
+General styles for customizing the tree.
+
+Signature:
+
+```typescript
+styles?: TreeStyles;
+```
diff --git a/packages/components/docs/markdown/components.usebuttonprops.md b/packages/components/docs/markdown/components.usebuttonprops.md
new file mode 100644
index 00000000..54df3433
--- /dev/null
+++ b/packages/components/docs/markdown/components.usebuttonprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useButtonProps](./components.usebuttonprops.md)
+
+## useButtonProps() function
+
+Signature:
+
+```typescript
+export declare function useButtonProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<IButtonProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<IButtonProps>
+
diff --git a/packages/components/docs/markdown/components.usecheckboxprops.md b/packages/components/docs/markdown/components.usecheckboxprops.md
new file mode 100644
index 00000000..21c5ebc7
--- /dev/null
+++ b/packages/components/docs/markdown/components.usecheckboxprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useCheckboxProps](./components.usecheckboxprops.md)
+
+## useCheckboxProps() function
+
+Signature:
+
+```typescript
+export declare function useCheckboxProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<ICheckboxProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<ICheckboxProps>
+
diff --git a/packages/components/docs/markdown/components.usechoicegroupprops.md b/packages/components/docs/markdown/components.usechoicegroupprops.md
new file mode 100644
index 00000000..711dd844
--- /dev/null
+++ b/packages/components/docs/markdown/components.usechoicegroupprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useChoiceGroupProps](./components.usechoicegroupprops.md)
+
+## useChoiceGroupProps() function
+
+Signature:
+
+```typescript
+export declare function useChoiceGroupProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<IChoiceGroupProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<IChoiceGroupProps>
+
diff --git a/packages/components/docs/markdown/components.usecolorpickerprops.md b/packages/components/docs/markdown/components.usecolorpickerprops.md
new file mode 100644
index 00000000..8fd364f2
--- /dev/null
+++ b/packages/components/docs/markdown/components.usecolorpickerprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useColorPickerProps](./components.usecolorpickerprops.md)
+
+## useColorPickerProps() function
+
+Signature:
+
+```typescript
+export declare function useColorPickerProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<IColorPickerProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<IColorPickerProps>
+
diff --git a/packages/components/docs/markdown/components.usedropdownprops.md b/packages/components/docs/markdown/components.usedropdownprops.md
new file mode 100644
index 00000000..f93e0b1e
--- /dev/null
+++ b/packages/components/docs/markdown/components.usedropdownprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useDropdownProps](./components.usedropdownprops.md)
+
+## useDropdownProps() function
+
+Signature:
+
+```typescript
+export declare function useDropdownProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<IDropdownProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<IDropdownProps>
+
diff --git a/packages/components/docs/markdown/components.useiconbuttonprops.md b/packages/components/docs/markdown/components.useiconbuttonprops.md
new file mode 100644
index 00000000..197accb9
--- /dev/null
+++ b/packages/components/docs/markdown/components.useiconbuttonprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useIconButtonProps](./components.useiconbuttonprops.md)
+
+## useIconButtonProps() function
+
+Signature:
+
+```typescript
+export declare function useIconButtonProps(props: IButtonProps, size?: Size): IButtonProps;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | IButtonProps | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+IButtonProps
+
diff --git a/packages/components/docs/markdown/components.uselabelprops.md b/packages/components/docs/markdown/components.uselabelprops.md
new file mode 100644
index 00000000..e935235b
--- /dev/null
+++ b/packages/components/docs/markdown/components.uselabelprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useLabelProps](./components.uselabelprops.md)
+
+## useLabelProps() function
+
+Signature:
+
+```typescript
+export declare function useLabelProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<ILabelProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<ILabelProps>
+
diff --git a/packages/components/docs/markdown/components.usenavprops.md b/packages/components/docs/markdown/components.usenavprops.md
new file mode 100644
index 00000000..11801868
--- /dev/null
+++ b/packages/components/docs/markdown/components.usenavprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useNavProps](./components.usenavprops.md)
+
+## useNavProps() function
+
+Signature:
+
+```typescript
+export declare function useNavProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<INavProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<INavProps>
+
diff --git a/packages/components/docs/markdown/components.usepivotprops.md b/packages/components/docs/markdown/components.usepivotprops.md
new file mode 100644
index 00000000..0e6468e3
--- /dev/null
+++ b/packages/components/docs/markdown/components.usepivotprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [usePivotProps](./components.usepivotprops.md)
+
+## usePivotProps() function
+
+Signature:
+
+```typescript
+export declare function usePivotProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<IPivotProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<IPivotProps>
+
diff --git a/packages/components/docs/markdown/components.usesliderprops.md b/packages/components/docs/markdown/components.usesliderprops.md
new file mode 100644
index 00000000..f451c155
--- /dev/null
+++ b/packages/components/docs/markdown/components.usesliderprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useSliderProps](./components.usesliderprops.md)
+
+## useSliderProps() function
+
+Signature:
+
+```typescript
+export declare function useSliderProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<ISliderProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<ISliderProps>
+
diff --git a/packages/components/docs/markdown/components.usespinbuttonprops.md b/packages/components/docs/markdown/components.usespinbuttonprops.md
new file mode 100644
index 00000000..118520ac
--- /dev/null
+++ b/packages/components/docs/markdown/components.usespinbuttonprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useSpinButtonProps](./components.usespinbuttonprops.md)
+
+## useSpinButtonProps() function
+
+Signature:
+
+```typescript
+export declare function useSpinButtonProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<ISpinButtonProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<ISpinButtonProps>
+
diff --git a/packages/components/docs/markdown/components.usetextfieldprops.md b/packages/components/docs/markdown/components.usetextfieldprops.md
new file mode 100644
index 00000000..bcedea79
--- /dev/null
+++ b/packages/components/docs/markdown/components.usetextfieldprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useTextFieldProps](./components.usetextfieldprops.md)
+
+## useTextFieldProps() function
+
+Signature:
+
+```typescript
+export declare function useTextFieldProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<ITextFieldProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<ITextFieldProps>
+
diff --git a/packages/components/docs/markdown/components.usetoggleprops.md b/packages/components/docs/markdown/components.usetoggleprops.md
new file mode 100644
index 00000000..6f563438
--- /dev/null
+++ b/packages/components/docs/markdown/components.usetoggleprops.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/components](./components.md) > [useToggleProps](./components.usetoggleprops.md)
+
+## useToggleProps() function
+
+Signature:
+
+```typescript
+export declare function useToggleProps(props: Partial, size?: Size): Partial;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| props | Partial<IToggleProps> | |
+| size | [Size](./components.size.md) | (Optional) |
+
+Returns:
+
+Partial<IToggleProps>
+
diff --git a/packages/components/docs/markdown/index.md b/packages/components/docs/markdown/index.md
new file mode 100644
index 00000000..a2a5f43f
--- /dev/null
+++ b/packages/components/docs/markdown/index.md
@@ -0,0 +1,12 @@
+
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+| Package | Description |
+| --- | --- |
+| [@essex/components](./components.md) | |
+
diff --git a/packages/components/docs/report/components.api.json b/packages/components/docs/report/components.api.json
new file mode 100644
index 00000000..2865a855
--- /dev/null
+++ b/packages/components/docs/report/components.api.json
@@ -0,0 +1,6811 @@
+{
+ "metadata": {
+ "toolPackage": "@microsoft/api-extractor",
+ "toolVersion": "7.29.2",
+ "schemaVersion": 1009,
+ "oldestForwardsCompatibleVersion": 1001,
+ "tsdocConfig": {
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+ "noStandardTags": true,
+ "tagDefinitions": [
+ {
+ "tagName": "@alpha",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@beta",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@defaultValue",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@decorator",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@deprecated",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@eventProperty",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@example",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@experimental",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@inheritDoc",
+ "syntaxKind": "inline"
+ },
+ {
+ "tagName": "@internal",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@label",
+ "syntaxKind": "inline"
+ },
+ {
+ "tagName": "@link",
+ "syntaxKind": "inline",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@override",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@packageDocumentation",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@param",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@privateRemarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@public",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@readonly",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@remarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@returns",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@sealed",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@see",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@throws",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@typeParam",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@virtual",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@betaDocumentation",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@internalRemarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@preapproved",
+ "syntaxKind": "modifier"
+ }
+ ],
+ "supportForTags": {
+ "@alpha": true,
+ "@beta": true,
+ "@defaultValue": true,
+ "@decorator": true,
+ "@deprecated": true,
+ "@eventProperty": true,
+ "@example": true,
+ "@experimental": true,
+ "@inheritDoc": true,
+ "@internal": true,
+ "@label": true,
+ "@link": true,
+ "@override": true,
+ "@packageDocumentation": true,
+ "@param": true,
+ "@privateRemarks": true,
+ "@public": true,
+ "@readonly": true,
+ "@remarks": true,
+ "@returns": true,
+ "@sealed": true,
+ "@see": true,
+ "@throws": true,
+ "@typeParam": true,
+ "@virtual": true,
+ "@betaDocumentation": true,
+ "@internalRemarks": true,
+ "@preapproved": true
+ },
+ "reportUnsupportedHtmlElements": false
+ }
+ },
+ "kind": "Package",
+ "canonicalReference": "@essex/components!",
+ "docComment": "",
+ "name": "@essex/components",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "EntryPoint",
+ "canonicalReference": "@essex/components!",
+ "name": "",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!ButtonChoiceGroup:var",
+ "docComment": "/**\n * ButtonChoiceGroup is a ChoiceGroup component that renders as buttons instead of radios.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "ButtonChoiceGroup: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IChoiceGroupProps",
+ "canonicalReference": "@fluentui/react!IChoiceGroupProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "ButtonChoiceGroup",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!ClippedGraph:var",
+ "docComment": "/**\n * Creates a line chart that handles extreme distributions with a few clipping/wrapping strategies. The \"clipped graph\" concept was presented by Haihan Lin at VIS2019. https://vdl.sci.utah.edu/publications/2019_infovis_clipped_graphs/ This chart can also produce a horizon plot, or be formatted to look like a sparkline. For examples of these variants, see the visual sandbox: https://visualsandbox.azurewebsites.net/#/experiments/clipped-graphs\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "ClippedGraph: "
+ },
+ {
+ "kind": "Content",
+ "text": "({ data, width, height, clipped, percentile, gradient, gradientInterpolation, gradientBand, horizon, sparkline, }: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ClippedGraphProps",
+ "canonicalReference": "@essex/components!ClippedGraphProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => "
+ },
+ {
+ "kind": "Reference",
+ "text": "JSX.Element",
+ "canonicalReference": "@types/react!~__global.JSX.Element:interface"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "ClippedGraph",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!ClippedGraphProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ClippedGraphProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ClippedGraphProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ClippedGraphProps#clipped:member",
+ "docComment": "/**\n * Indicates that the y axis should be clipped due to extreme values. 90th percentile will be plotted.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "clipped?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "clipped",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ClippedGraphProps#data:member",
+ "docComment": "/**\n * List of values to plot. Currently this is the y axis, the x axis is ordinal. TODO: support more complex data types such as x/y points or explicit time series.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "data: "
+ },
+ {
+ "kind": "Content",
+ "text": "number[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "data",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ClippedGraphProps#gradient:member",
+ "docComment": "/**\n * Indicates if a gradient fill should be used under the line to add redundant data encoding.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "gradient?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "gradient",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ClippedGraphProps#gradientBand:member",
+ "docComment": "/**\n * Indicates if the gradient should just be a band along the top instead of filling under the line. If supplied, this should be a height for the band in pixels.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "gradientBand?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "gradientBand",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ClippedGraphProps#gradientInterpolation:member",
+ "docComment": "/**\n * This is a multiplier to use for interpolating gradient values between data values. If your data is not very dense, the gradient fill will look very blocky. Defaults to 4.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "gradientInterpolation?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "gradientInterpolation",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ClippedGraphProps#height:member",
+ "docComment": "/**\n * Height of the chart in pixels.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "height: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "height",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ClippedGraphProps#horizon:member",
+ "docComment": "/**\n * Indicates to create a horizon plot instead, by 'wrapping' the top 10% data values around the y axis.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "horizon?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "horizon",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ClippedGraphProps#percentile:member",
+ "docComment": "/**\n * Percentile of the data to plot on the main graph. The remainder will be plotted as overflow.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "percentile?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "percentile",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ClippedGraphProps#sparkline:member",
+ "docComment": "/**\n * Render this as a sparkline, i.e., much thinner and lighter.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "sparkline?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "sparkline",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ClippedGraphProps#width:member",
+ "docComment": "/**\n * Width of the chart in pixels.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "width: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "width",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!CollapsiblePanel:var",
+ "docComment": "/**\n * CollapsiblePanel displays a Header and its child that collapse and expands with keyboard arrows, space, enter or onclick showing the 'hidden' rendering\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "CollapsiblePanel: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "PropsWithChildren",
+ "canonicalReference": "@types/react!~React.PropsWithChildren:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "CollapsiblePanelProps",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">>"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "CollapsiblePanel",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 7
+ }
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!CollapsiblePanelContainer:var",
+ "docComment": "/**\n * Receives an array of CollapsiblePanel as children to render it with first and last props calculating it automatically\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "CollapsiblePanelContainer: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "PropsWithChildren",
+ "canonicalReference": "@types/react!~React.PropsWithChildren:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "CollapsiblePanelContainerProps",
+ "canonicalReference": "@essex/components!CollapsiblePanelContainerProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">>"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "CollapsiblePanelContainer",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 7
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!CollapsiblePanelContainerProps:interface",
+ "docComment": "/**\n * The container that will have multiple CollapsiblePanel as children, passing the last and first params automatically.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface CollapsiblePanelContainerProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "CollapsiblePanelContainerProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelContainerProps#styles:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "styles?: "
+ },
+ {
+ "kind": "Content",
+ "text": "{\n root?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";\n }"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "styles",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 4
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps:interface",
+ "docComment": "/**\n * Props for the CollapsiblePanel\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface CollapsiblePanelProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "CollapsiblePanelProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#buttonProps:member",
+ "docComment": "/**\n * Custom props for the expand/collapse icon button.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "buttonProps?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IButtonProps",
+ "canonicalReference": "@fluentui/react!IButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "buttonProps",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#defaultExpanded:member",
+ "docComment": "/**\n * If true the initial state will be expanded\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "defaultExpanded?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "defaultExpanded",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#duration:member",
+ "docComment": "/**\n * Duration of the expand/collapse content animation.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "duration?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "duration",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#expanded:member",
+ "docComment": "/**\n * Optional boolean to control the state outside this component\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "expanded?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "expanded",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#first:member",
+ "docComment": "/**\n * If it's the first element of the panel it applies a different style\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "first?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "first",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#hideIcon:member",
+ "docComment": "/**\n * Hide the expand/collapse icon entirely. It is visible by default.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "hideIcon?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "hideIcon",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#last:member",
+ "docComment": "/**\n * If it's the last element of the panel it applies a different style\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "last?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "last",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#onHeaderClick:member",
+ "docComment": "/**\n * Optional function to respond to clicks in the general header area.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onHeaderClick?: "
+ },
+ {
+ "kind": "Content",
+ "text": "() => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onHeaderClick",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#onIconClick:member",
+ "docComment": "/**\n * Optional function to respond to clicks on the expand/collapse icon directly.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onIconClick?: "
+ },
+ {
+ "kind": "Content",
+ "text": "() => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onIconClick",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#onRenderHeader:member",
+ "docComment": "/**\n * Optional function to render a different header than the default. Note that if you supply a custom header renderer with interactive controls, you may need to call e.stopPropagation in their click handlers to prevent unwanted expand/collapse behavior.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onRenderHeader?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IRenderFunction",
+ "canonicalReference": "@fluentui/utilities!IRenderFunction:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onRenderHeader",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#styles:member",
+ "docComment": "/**\n * Custom styles for the subcomponents\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "styles?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CollapsiblePanelStyles",
+ "canonicalReference": "@essex/components!CollapsiblePanelStyles:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "styles",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelProps#title:member",
+ "docComment": "/**\n * Title for the panel\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "title?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "title",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!CollapsiblePanelStyles:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface CollapsiblePanelStyles "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "CollapsiblePanelStyles",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelStyles#content:member",
+ "docComment": "/**\n * Style for the content container\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "content?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "content",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelStyles#header:member",
+ "docComment": "/**\n * Style for the outer header container\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "header?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "header",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelStyles#root:member",
+ "docComment": "/**\n * Style for outer component container\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "root?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "root",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelStyles#title:member",
+ "docComment": "/**\n * Style for the header title text\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "title?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "title",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!CollapsiblePanelStyles#titleContainer:member",
+ "docComment": "/**\n * Container box around the title text\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "titleContainer?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "titleContainer",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!ColumnarMenu:var",
+ "docComment": "/**\n * Dropdown button menu that supports grouped items (using sectionProps) in a columnar layout. This is a hybrid control that uses a button to create the dropdown menu, but overrides the menu renderer to lay out any item sections as columns instead of a vertical stack.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "ColumnarMenu: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ColumnarMenuProps",
+ "canonicalReference": "@essex/components!ColumnarMenuProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "ColumnarMenu",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!ColumnarMenuList:var",
+ "docComment": "/**\n * This component replaces the default ContextualMenuList rendering with a columnar layout of the sections instead of vertical stacks. Note that items should be sorted into sections with sectionProps, though options buttons do not need to be in a section and will all be coalesced at the top.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "ColumnarMenuList: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ColumnarMenuListProps",
+ "canonicalReference": "@essex/components!ColumnarMenuListProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "ColumnarMenuList",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!ColumnarMenuProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ColumnarMenuProps extends "
+ },
+ {
+ "kind": "Reference",
+ "text": "IContextualMenuProps",
+ "canonicalReference": "@fluentui/react!IContextualMenuProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ColumnarMenuProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ColumnarMenuProps#buttonProps:member",
+ "docComment": "/**\n * Props to customize the menu button\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "buttonProps?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IButtonProps",
+ "canonicalReference": "@fluentui/react!IButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "buttonProps",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ColumnarMenuProps#menuListProps:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "menuListProps?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ColumnarMenuListProps",
+ "canonicalReference": "@essex/components!ColumnarMenuListProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "menuListProps",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ColumnarMenuProps#text:member",
+ "docComment": "/**\n * Text to display in the menu button\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "text?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "text",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": [
+ {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ ]
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!ControlledHistogramFilter:var",
+ "docComment": "/**\n * ControlledHistogramFilter displays a histogram that contains a D3 brush and basic numberical filtering with thematic theming\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "ControlledHistogramFilter: "
+ },
+ {
+ "kind": "Content",
+ "text": "({ name, data, width, height, selectedRange, onChange, selectedFill, unselectedFill, }: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ControlledHistogramFilterProps",
+ "canonicalReference": "@essex/components!ControlledHistogramFilterProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => "
+ },
+ {
+ "kind": "Reference",
+ "text": "JSX.Element",
+ "canonicalReference": "@types/react!~__global.JSX.Element:interface"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "ControlledHistogramFilter",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!ControlledHistogramFilterProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ControlledHistogramFilterProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ControlledHistogramFilterProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ControlledHistogramFilterProps#data:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "data: "
+ },
+ {
+ "kind": "Content",
+ "text": "number[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "data",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ControlledHistogramFilterProps#height:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "height: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "height",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ControlledHistogramFilterProps#name:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "name: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "name",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ControlledHistogramFilterProps#onChange:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onChange?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(range: [number | undefined, number | undefined]) => any"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onChange",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ControlledHistogramFilterProps#selectedFill:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "selectedFill?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "selectedFill",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ControlledHistogramFilterProps#selectedRange:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "selectedRange: "
+ },
+ {
+ "kind": "Content",
+ "text": "[number | undefined, number | undefined]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "selectedRange",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ControlledHistogramFilterProps#unselectedFill:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "unselectedFill?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "unselectedFill",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ControlledHistogramFilterProps#width:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "width: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "width",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "TypeAlias",
+ "canonicalReference": "@essex/components!CookieConsent:type",
+ "docComment": "/**\n * Record of approved and blocked cookie types.\n *\n * Record<\"Required\" | \"Analytics\" | \"SocialMedia\" | \"Advertising\", boolean>\n *\n * @public\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export type CookieConsent = "
+ },
+ {
+ "kind": "Reference",
+ "text": "Record",
+ "canonicalReference": "!Record:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "CookieConsentCategories",
+ "canonicalReference": "@essex/components!CookieConsentCategories:enum"
+ },
+ {
+ "kind": "Content",
+ "text": ", boolean>"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "CookieConsent",
+ "typeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "TypeAlias",
+ "canonicalReference": "@essex/components!CookieConsentBannerThemes:type",
+ "docComment": "/**\n * Theme of the cookie consent banner popup that is managed by the wcp script. This sets the theme for the popup only and does not impact the theme of the policy footer or links. The policy footer uses FluentUI so it should pick up the theme from parent FluentUI theme provider.\n *\n * @public\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export type CookieConsentBannerThemes = "
+ },
+ {
+ "kind": "Content",
+ "text": "'light' | 'dark' | 'high-contrast'"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "CookieConsentBannerThemes",
+ "typeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "Enum",
+ "canonicalReference": "@essex/components!CookieConsentCategories:enum",
+ "docComment": "/**\n * @public\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare enum CookieConsentCategories "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "CookieConsentCategories",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "EnumMember",
+ "canonicalReference": "@essex/components!CookieConsentCategories.Advertising:member",
+ "docComment": "/**\n * Cookies to record which ads are already seen, clicked, or purchased\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "Advertising = "
+ },
+ {
+ "kind": "Content",
+ "text": "\"Advertising\""
+ }
+ ],
+ "initializerTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "releaseTag": "Public",
+ "name": "Advertising"
+ },
+ {
+ "kind": "EnumMember",
+ "canonicalReference": "@essex/components!CookieConsentCategories.Analytics:member",
+ "docComment": "/**\n * Cookies to understand how website is used, may be also used on 3rd party websites that are not owned or operated by Microsoft\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "Analytics = "
+ },
+ {
+ "kind": "Content",
+ "text": "\"Analytics\""
+ }
+ ],
+ "initializerTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "releaseTag": "Public",
+ "name": "Analytics"
+ },
+ {
+ "kind": "EnumMember",
+ "canonicalReference": "@essex/components!CookieConsentCategories.Required:member",
+ "docComment": "/**\n * Cookies to perform essential website functions (sign-in, language settings,...)\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "Required = "
+ },
+ {
+ "kind": "Content",
+ "text": "\"Required\""
+ }
+ ],
+ "initializerTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "releaseTag": "Public",
+ "name": "Required"
+ },
+ {
+ "kind": "EnumMember",
+ "canonicalReference": "@essex/components!CookieConsentCategories.SocialMedia:member",
+ "docComment": "/**\n * Cookies to show ads and content based on user social media profiles and activity on Microsoft websites\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "SocialMedia = "
+ },
+ {
+ "kind": "Content",
+ "text": "\"SocialMedia\""
+ }
+ ],
+ "initializerTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "releaseTag": "Public",
+ "name": "SocialMedia"
+ }
+ ]
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!defaultBannerLinks:var",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "defaultBannerLinks: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Array",
+ "canonicalReference": "!Array:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "PolicyLinkDetails",
+ "canonicalReference": "@essex/components!PolicyLinkDetails:type"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "defaultBannerLinks",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!DialogConfirm:var",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "DialogConfirm: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<{\n toggle: () => void;\n onConfirm: () => void;\n show?: boolean;\n title: string;\n subText?: string;\n}>"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "DialogConfirm",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!EnumButtonBar:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function EnumButtonBar({ enumeration, selected, onChange, styles, iconNames, iconOnly, }: "
+ },
+ {
+ "kind": "Reference",
+ "text": "EnumButtonBarProps",
+ "canonicalReference": "@essex/components!EnumButtonBarProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "JSX.Element",
+ "canonicalReference": "@types/react!~__global.JSX.Element:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 4,
+ "endIndex": 5
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "{ enumeration, selected, onChange, styles, iconNames, iconOnly, }",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ },
+ "isOptional": false
+ }
+ ],
+ "typeParameters": [
+ {
+ "typeParameterName": "E",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "EnumButtonBar"
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!EnumButtonBarProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface EnumButtonBarProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "E",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "EnumButtonBarProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!EnumButtonBarProps#enumeration:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "enumeration: "
+ },
+ {
+ "kind": "Content",
+ "text": "any"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "enumeration",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!EnumButtonBarProps#iconNames:member",
+ "docComment": "/**\n * List of icons for each enum option. Must match the indices of the enum entries.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "iconNames?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "iconNames",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!EnumButtonBarProps#iconOnly:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "iconOnly?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "iconOnly",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!EnumButtonBarProps#onChange:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onChange?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(selected: string | number) => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onChange",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!EnumButtonBarProps#selected:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "selected?: "
+ },
+ {
+ "kind": "Content",
+ "text": "E"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "selected",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!EnumButtonBarProps#styles:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "styles?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IStyleFunctionOrObject",
+ "canonicalReference": "@fluentui/merge-styles!IStyleFunctionOrObject:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ICommandBarStyleProps",
+ "canonicalReference": "@fluentui/react!ICommandBarStyleProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ", "
+ },
+ {
+ "kind": "Reference",
+ "text": "ICommandBarStyles",
+ "canonicalReference": "@fluentui/react!ICommandBarStyles:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "styles",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 7
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!EnumDropdown:var",
+ "docComment": "/**\n * Dropdown wrapper to list out aggregation operations.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "EnumDropdown: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "EnumDropdownProps",
+ "canonicalReference": "@essex/components!EnumDropdownProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "EnumDropdown",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!EnumDropdownProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface EnumDropdownProps extends "
+ },
+ {
+ "kind": "Reference",
+ "text": "Omit",
+ "canonicalReference": "!Omit:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IDropdownProps",
+ "canonicalReference": "@fluentui/react!IDropdownProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ", 'options'>"
+ },
+ {
+ "kind": "Content",
+ "text": " "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "E",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "name": "EnumDropdownProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!EnumDropdownProps#enumeration:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "enumeration: "
+ },
+ {
+ "kind": "Content",
+ "text": "E"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "enumeration",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!EnumDropdownProps#labels:member",
+ "docComment": "/**\n * Optional labels to map enum keys to alternate text. This is helpful for when the enum values may not be as user-friendly.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "labels?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Record",
+ "canonicalReference": "!Record:type"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "labels",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ }
+ ],
+ "extendsTokenRanges": [
+ {
+ "startIndex": 3,
+ "endIndex": 7
+ }
+ ]
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!Expando:var",
+ "docComment": "/**\n * Toggle link with a chevron and show/hide of children.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "Expando: "
+ },
+ {
+ "kind": "Reference",
+ "text": "FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "PropsWithChildren",
+ "canonicalReference": "@types/react!~React.PropsWithChildren:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ExpandoProps",
+ "canonicalReference": "@essex/components!ExpandoProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">>"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "Expando",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 7
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!ExpandoProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ExpandoProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ExpandoProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ExpandoProps#defaultExpanded:member",
+ "docComment": "/**\n * Whether to expand the container by default.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "defaultExpanded?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "defaultExpanded",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ExpandoProps#iconButtonProps:member",
+ "docComment": "/**\n * Props to customize the open/close chevron. Note that the default switches the orientation of the chevron, overriding these will lose that state switch.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "iconButtonProps?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IButtonProps",
+ "canonicalReference": "@fluentui/react!IButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "iconButtonProps",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ExpandoProps#label:member",
+ "docComment": "/**\n * Toggle link label text.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "label: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "label",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ExpandoProps#linkProps:member",
+ "docComment": "/**\n * Custom props for the link label.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "linkProps?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ILinkProps",
+ "canonicalReference": "@fluentui/react!ILinkProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "linkProps",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ExpandoProps#styles:member",
+ "docComment": "/**\n * Custom styles for the component.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "styles?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ExpandoStyles",
+ "canonicalReference": "@essex/components!ExpandoStyles:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "styles",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!ExpandoStyles:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ExpandoStyles "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ExpandoStyles",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ExpandoStyles#content:member",
+ "docComment": "/**\n * Content container - the panel displayed with child content once expanded.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "content?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "content",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ExpandoStyles#expando:member",
+ "docComment": "/**\n * Expando container - i.e., the toggle icon and link.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "expando?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "expando",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ExpandoStyles#root:member",
+ "docComment": "/**\n * Root container.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "root?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "root",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!FilterTextbox:var",
+ "docComment": "/**\n * This component presents a compound textbox filter that includes an inline toggle button to switch between inclusion and exclusion of the filter text. To use this component, ensure that Fluent is bootstrapped to include loaded icons See https://developer.microsoft.com/en-us/fluentui#/styles/web/icons\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "FilterTextbox: "
+ },
+ {
+ "kind": "Content",
+ "text": "({ label, includePlaceholder, excludePlaceholder, onFilter, }: "
+ },
+ {
+ "kind": "Reference",
+ "text": "FilterTextboxProps",
+ "canonicalReference": "@essex/components!FilterTextboxProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => "
+ },
+ {
+ "kind": "Reference",
+ "text": "JSX.Element",
+ "canonicalReference": "@types/react!~__global.JSX.Element:interface"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "FilterTextbox",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!FilterTextboxProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface FilterTextboxProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "FilterTextboxProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!FilterTextboxProps#excludePlaceholder:member",
+ "docComment": "/**\n * Placeholder text to use when filter is in 'exclude' state.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "excludePlaceholder?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "excludePlaceholder",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!FilterTextboxProps#includePlaceholder:member",
+ "docComment": "/**\n * Placeholder text to use when filter is in 'include' state.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "includePlaceholder?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "includePlaceholder",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!FilterTextboxProps#label:member",
+ "docComment": "/**\n * Label to display above the textbox.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "label?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "label",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!FilterTextboxProps#onFilter:member",
+ "docComment": "/**\n * Callback that fires when filter text changes or the include/exclude button is toggled.\n *\n * @param text - value from the textbox\n *\n * @param exclude - indicates whether exclusion toggle was on\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onFilter?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(text: string, exclude: boolean) => any"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onFilter",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!getEnumDropdownOptions:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function getEnumDropdownOptions"
+ },
+ {
+ "kind": "Content",
+ "text": ">(enumeration: "
+ },
+ {
+ "kind": "Content",
+ "text": "E"
+ },
+ {
+ "kind": "Content",
+ "text": ", labels?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Record",
+ "canonicalReference": "!Record:type"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "IDropdownOption",
+ "canonicalReference": "@fluentui/react!IDropdownOption:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 9,
+ "endIndex": 11
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "enumeration",
+ "parameterTypeTokenRange": {
+ "startIndex": 4,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "labels",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 8
+ },
+ "isOptional": true
+ }
+ ],
+ "typeParameters": [
+ {
+ "typeParameterName": "E",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ }
+ ],
+ "name": "getEnumDropdownOptions"
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!MultiDropdown:var",
+ "docComment": "/**\n * Dropdown wrapper to manage multi-select with a select all/none helper.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "MultiDropdown: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "MultiDropdownProps",
+ "canonicalReference": "@essex/components!MultiDropdownProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "MultiDropdown",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!MultiDropdownProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface MultiDropdownProps extends "
+ },
+ {
+ "kind": "Reference",
+ "text": "IDropdownProps",
+ "canonicalReference": "@fluentui/react!IDropdownProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "MultiDropdownProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!MultiDropdownProps#onChangeAll:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onChangeAll?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(event: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.MouseEvent",
+ "canonicalReference": "@types/react!~React.MouseEvent:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "HTMLAnchorElement",
+ "canonicalReference": "!HTMLAnchorElement:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | "
+ },
+ {
+ "kind": "Reference",
+ "text": "HTMLButtonElement",
+ "canonicalReference": "!HTMLButtonElement:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | "
+ },
+ {
+ "kind": "Reference",
+ "text": "HTMLElement",
+ "canonicalReference": "!HTMLElement:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">, options?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IDropdownOption",
+ "canonicalReference": "@fluentui/react!IDropdownOption:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[], indexes?: number[]) => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onChangeAll",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 12
+ }
+ }
+ ],
+ "extendsTokenRanges": [
+ {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ ]
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!NumberSpinButton:var",
+ "docComment": "/**\n * NumberSpinButton creates a thematic styled SpinButton from Fluent\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "NumberSpinButton: "
+ },
+ {
+ "kind": "Content",
+ "text": "({ label, value, min, max, step, onChange, labelPosition, incrementButtonAriaLabel, decrementButtonAriaLabel, }: "
+ },
+ {
+ "kind": "Reference",
+ "text": "NumberSpinButtonProps",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => "
+ },
+ {
+ "kind": "Reference",
+ "text": "JSX.Element",
+ "canonicalReference": "@types/react!~__global.JSX.Element:interface"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "NumberSpinButton",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface NumberSpinButtonProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "NumberSpinButtonProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps#decrementButtonAriaLabel:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "decrementButtonAriaLabel?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "decrementButtonAriaLabel",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps#incrementButtonAriaLabel:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "incrementButtonAriaLabel?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "incrementButtonAriaLabel",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps#label:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "label: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "label",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps#labelPosition:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "labelPosition?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Position",
+ "canonicalReference": "@fluentui/react!Position:enum"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "labelPosition",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps#max:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "max?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "max",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps#min:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "min?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "min",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps#onChange:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onChange?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(n: number) => any"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onChange",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps#step:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "step?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "step",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!NumberSpinButtonProps#value:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "value: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "value",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!PolicyAndCookieBanner:var",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "PolicyAndCookieBanner: "
+ },
+ {
+ "kind": "Reference",
+ "text": "FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "PolicyAndCookieBannerProps",
+ "canonicalReference": "@essex/components!PolicyAndCookieBannerProps:type"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "PolicyAndCookieBanner",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "TypeAlias",
+ "canonicalReference": "@essex/components!PolicyAndCookieBannerProps:type",
+ "docComment": "/**\n * Defaults to { language: navigator.language ?? 'en-US' theme: 'light', onConsentChange: () => void, links: [ { name: 'Privacy & Cookies', href: ' https://go.microsoft.com/fwlink/?LinkId=521839', }, { name: 'Terms of Use', href: 'https://go.microsoft.com/fwlink/?LinkID=760869', }, { name: 'Trademarks', href: 'https://www.microsoft.com/en-us/legal/intellectualproperty/Trademarks/EN-US.aspx', }, { name: 'Contact Us', href: 'https://go.microsoft.com/?linkid=2028325', }, { name: 'Code of Conduct', href: 'https://opensource.microsoft.com/codeofconduct/', }, { name: `©️ ${new Date().getFullYear()} Microsoft`, href: 'https://www.microsoft.com/en-us/legal/intellectualproperty/copyright', }, ] }\n *\n * @public\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export type PolicyAndCookieBannerProps = "
+ },
+ {
+ "kind": "Content",
+ "text": "{\n language?: string;\n theme?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CookieConsentBannerThemes",
+ "canonicalReference": "@essex/components!CookieConsentBannerThemes:type"
+ },
+ {
+ "kind": "Content",
+ "text": ";\n onConsentChange?: (newConsent: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CookieConsent",
+ "canonicalReference": "@essex/components!CookieConsent:type"
+ },
+ {
+ "kind": "Content",
+ "text": ") => void;\n onError: (error: unknown) => void;\n className?: string;\n styles?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";\n links?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Array",
+ "canonicalReference": "!Array:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "PolicyLinkDetails",
+ "canonicalReference": "@essex/components!PolicyLinkDetails:type"
+ },
+ {
+ "kind": "Content",
+ "text": ">;\n}"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "PolicyAndCookieBannerProps",
+ "typeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 12
+ }
+ },
+ {
+ "kind": "TypeAlias",
+ "canonicalReference": "@essex/components!PolicyLinkDetails:type",
+ "docComment": "/**\n * @public\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export type PolicyLinkDetails = "
+ },
+ {
+ "kind": "Content",
+ "text": "{\n name: string;\n href: string;\n}"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "PolicyLinkDetails",
+ "typeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!ReadOnlyTextField:var",
+ "docComment": "/**\n * This is a standard TextField, with default styles overridden to provide some consistent \"read only look\" that visually indicates the field can't be edited without looking fully disabled.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "ReadOnlyTextField: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ITextFieldProps",
+ "canonicalReference": "@fluentui/react!ITextFieldProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "ReadOnlyTextField",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!SearchBox:var",
+ "docComment": "/**\n * Extends the idea of a SearchBox to include the Search button alongside the text field. Note that this is a compound TextField + PrimaryButton. We may want to switch the the Fluent SearchBox field, which includes autocomplete capability.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "SearchBox: "
+ },
+ {
+ "kind": "Content",
+ "text": "({ defaultValue, label, placeholder, errorMessage, onSearch, }: "
+ },
+ {
+ "kind": "Reference",
+ "text": "SearchBoxProps",
+ "canonicalReference": "@essex/components!SearchBoxProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => "
+ },
+ {
+ "kind": "Reference",
+ "text": "JSX.Element",
+ "canonicalReference": "@types/react!~__global.JSX.Element:interface"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "SearchBox",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!SearchBoxProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface SearchBoxProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "SearchBoxProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SearchBoxProps#defaultValue:member",
+ "docComment": "/**\n * Value to display in the box on initial display.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "defaultValue?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "defaultValue",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SearchBoxProps#errorMessage:member",
+ "docComment": "/**\n * Error message to display below the text field when applicable.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "errorMessage?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "errorMessage",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SearchBoxProps#label:member",
+ "docComment": "/**\n * Label above the search box.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "label?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "label",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SearchBoxProps#onSearch:member",
+ "docComment": "/**\n * Callback to receive query text when the user presses enter or clicks the search button.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onSearch?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(query: string) => any"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onSearch",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SearchBoxProps#placeholder:member",
+ "docComment": "/**\n * Placeholder text for the empty text field.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "placeholder?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "placeholder",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!Settings:var",
+ "docComment": "/**\n * A zero-config settings panel that parses a supplied object and generates a list of Fluent UI controls based on the data types. A config object can be supplied that maps specific object fields to more detailed control config, such as changing between a Toggle or Checkbox. In addition, it will invoke a onChange handler for any setting, supplying the changed setting's key and new value. Note that this could be used in an entirely declarative/serializable manner if desired.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "Settings: "
+ },
+ {
+ "kind": "Content",
+ "text": "({ settings, config, groups, onChange, }: "
+ },
+ {
+ "kind": "Reference",
+ "text": "SettingsProps",
+ "canonicalReference": "@essex/components!SettingsProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => "
+ },
+ {
+ "kind": "Reference",
+ "text": "JSX.Element",
+ "canonicalReference": "@types/react!~__global.JSX.Element:interface"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "Settings",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!SettingsGroup:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface SettingsGroup "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "SettingsGroup",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SettingsGroup#keys:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "keys: "
+ },
+ {
+ "kind": "Content",
+ "text": "string[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "keys",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SettingsGroup#label:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "label?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "label",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!SettingsProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface SettingsProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "SettingsProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SettingsProps#config:member",
+ "docComment": "/**\n * Map of optional config params for individual settings. The key should match the key present in the settings object.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "config?: "
+ },
+ {
+ "kind": "Content",
+ "text": "{\n [key: string]: "
+ },
+ {
+ "kind": "Reference",
+ "text": "SettingConfig",
+ "canonicalReference": "@essex/components!SettingConfig:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";\n }"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "config",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 4
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SettingsProps#groups:member",
+ "docComment": "/**\n * List of optional groups to sort the settings into, with a separator between each. The group is a list of the keys to include, with an optional label for the separator.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "groups?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "SettingsGroup",
+ "canonicalReference": "@essex/components!SettingsGroup:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "groups",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SettingsProps#onChange:member",
+ "docComment": "/**\n * Handler to notify when any of the settings has changed. Callback args will be the key and value that changed. Merging, etc. is up to the consumer.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onChange?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(key: string, value: any) => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onChange",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!SettingsProps#settings:member",
+ "docComment": "/**\n * Required object to render into a settings panel. This can be basically anything, but should be flat at the moment, as complex/nest objects are not supported.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "settings: "
+ },
+ {
+ "kind": "Content",
+ "text": "any"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "settings",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "TypeAlias",
+ "canonicalReference": "@essex/components!Size:type",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export type Size = "
+ },
+ {
+ "kind": "Content",
+ "text": "'small' | 'medium'"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "Size",
+ "typeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!Sized:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface Sized "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "Sized",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!Sized#size:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "size",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!ToggleLink:var",
+ "docComment": "/**\n * Presents a hyperlink that toggles between two messages, like a toggle button.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "ToggleLink: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ToggleLinkProps",
+ "canonicalReference": "@essex/components!ToggleLinkProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "ToggleLink",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!ToggleLinkProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ToggleLinkProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ToggleLinkProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToggleLinkProps#className:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "className?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "className",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToggleLinkProps#messages:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "messages: "
+ },
+ {
+ "kind": "Content",
+ "text": "[string, string]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "messages",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToggleLinkProps#onChange:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onChange?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(toggled: boolean) => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onChange",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToggleLinkProps#style:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "style?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "style",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!ToolPanel:var",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "ToolPanel: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "React.PropsWithChildren",
+ "canonicalReference": "@types/react!~React.PropsWithChildren:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ToolPanelProps",
+ "canonicalReference": "@essex/components!ToolPanelProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">>"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "ToolPanel",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 7
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!ToolPanelProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ToolPanelProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ToolPanelProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelProps#closeIconProps:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "closeIconProps?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IIconProps",
+ "canonicalReference": "@fluentui/react!IIconProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "closeIconProps",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelProps#hasCloseButton:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "hasCloseButton?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "hasCloseButton",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelProps#headerIconProps:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "headerIconProps?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IIconProps",
+ "canonicalReference": "@fluentui/react!IIconProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "headerIconProps",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelProps#headerText:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "headerText?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "headerText",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelProps#onDismiss:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onDismiss?: "
+ },
+ {
+ "kind": "Content",
+ "text": "() => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onDismiss",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelProps#styles:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "styles?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ToolPanelStyles",
+ "canonicalReference": "@essex/components!ToolPanelStyles:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "styles",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!ToolPanelStyles:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ToolPanelStyles "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ToolPanelStyles",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelStyles#content:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "content?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "content",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelStyles#header:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "header?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "header",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelStyles#root:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "root?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "root",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelStyles#title:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "title?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "title",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!ToolPanelStyles#titleContainer:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "titleContainer?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "titleContainer",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/components!Tree:var",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "Tree: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeProps",
+ "canonicalReference": "@essex/components!TreeProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "Tree",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!TreeGroup:interface",
+ "docComment": "/**\n * Defines groups available in a Tree. Individual TreeItems can use their group field to be sorted into known groups.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface TreeGroup "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "TreeGroup",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeGroup#key:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "key: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "key",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeGroup#text:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "text?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "text",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!TreeGroupProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface TreeGroupProps "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "TreeGroupProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeGroupProps#group:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "group: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeGroup",
+ "canonicalReference": "@essex/components!TreeGroup:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "group",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeGroupProps#onRenderGroupHeader:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onRenderGroupHeader?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IRenderFunction",
+ "canonicalReference": "@fluentui/utilities!IRenderFunction:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeGroupProps",
+ "canonicalReference": "@essex/components!TreeGroupProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onRenderGroupHeader",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeGroupProps#size:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "size",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeGroupProps#styles:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "styles?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeStyles",
+ "canonicalReference": "@essex/components!TreeStyles:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "styles",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!TreeItem:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface TreeItem "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "TreeItem",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#children:member",
+ "docComment": "/**\n * Child TreeItems to recursively render.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "children?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeItem",
+ "canonicalReference": "@essex/components!TreeItem:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "children",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#depth:member",
+ "docComment": "/**\n * Depth of the item, which affects its left position for hierarchical rendering.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "depth?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "depth",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#expanded:member",
+ "docComment": "/**\n * Indicates the item is expanded and should display child items and content.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "expanded?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "expanded",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#group:member",
+ "docComment": "/**\n * Key of the group this item belongs to, if groups are specified.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "group?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "group",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#iconName:member",
+ "docComment": "/**\n * Optional icon to show before the text.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "iconName?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "iconName",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#key:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "key: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "key",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#menuItems:member",
+ "docComment": "/**\n * List of menu items to display in a right-side dropdown menu.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "menuItems?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IContextualMenuItem",
+ "canonicalReference": "@fluentui/react!IContextualMenuItem:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "menuItems",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#onClick:member",
+ "docComment": "/**\n * Individual click handler for this item. Will suppress top-level onItemClick if set.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onClick?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(item: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeItem",
+ "canonicalReference": "@essex/components!TreeItem:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onClick",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 4
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#onExpand:member",
+ "docComment": "/**\n * Individual click handler for this item's expand/collapse icon. Will suppress top-level onItemExpandClick if set.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onExpand?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(item: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeItem",
+ "canonicalReference": "@essex/components!TreeItem:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onExpand",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 4
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#onRenderContent:member",
+ "docComment": "/**\n * Render function for the child content of the item, including child nodes.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onRenderContent?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IRenderFunction",
+ "canonicalReference": "@fluentui/utilities!IRenderFunction:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeItemProps",
+ "canonicalReference": "@essex/components!TreeItemProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onRenderContent",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#onRenderTitle:member",
+ "docComment": "/**\n * Render function for the title content of the item. Includes the content *between* the expand/collapse button and the menu items.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onRenderTitle?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IRenderFunction",
+ "canonicalReference": "@fluentui/utilities!IRenderFunction:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeItemProps",
+ "canonicalReference": "@essex/components!TreeItemProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onRenderTitle",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#selected:member",
+ "docComment": "/**\n * Indicates the item is selected and should be styled as such.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "selected?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "selected",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItem#text:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "text?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "text",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!TreeItemProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface TreeItemProps extends "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreePropsBase",
+ "canonicalReference": "@essex/components!TreePropsBase:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "TreeItemProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeItemProps#item:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "item: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeItem",
+ "canonicalReference": "@essex/components!TreeItem:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "item",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": [
+ {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ ]
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!TreeProps:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface TreeProps extends "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreePropsBase",
+ "canonicalReference": "@essex/components!TreePropsBase:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "TreeProps",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeProps#groups:member",
+ "docComment": "/**\n * Optional group definitions. If groups are defined, each root item must have a group key.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "groups?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeGroup",
+ "canonicalReference": "@essex/components!TreeGroup:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "groups",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeProps#items:member",
+ "docComment": "/**\n * List of items to render in the tree.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "items: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeItem",
+ "canonicalReference": "@essex/components!TreeItem:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "items",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeProps#onItemClick:member",
+ "docComment": "/**\n * Global handler for individual item clicks.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onItemClick?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(item: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeItem",
+ "canonicalReference": "@essex/components!TreeItem:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onItemClick",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 4
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeProps#onItemExpandClick:member",
+ "docComment": "/**\n * Global handler for individual expand/collapse icon clicks.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onItemExpandClick?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(item: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeItem",
+ "canonicalReference": "@essex/components!TreeItem:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onItemExpandClick",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 4
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeProps#onRenderGroupHeader:member",
+ "docComment": "/**\n * Render function to override the group header.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onRenderGroupHeader?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IRenderFunction",
+ "canonicalReference": "@fluentui/utilities!IRenderFunction:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeGroupProps",
+ "canonicalReference": "@essex/components!TreeGroupProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onRenderGroupHeader",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreeProps#selectedKey:member",
+ "docComment": "/**\n * Selected item in the tree.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "selectedKey?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "selectedKey",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": [
+ {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ ]
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/components!TreePropsBase:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface TreePropsBase "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "TreePropsBase",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreePropsBase#contentButtonProps:member",
+ "docComment": "/**\n * Override props for the main button used to render each tree item's content. Note that this includes the iconProps if you want to customize how the item's icon (if any) looks.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "contentButtonProps?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IButtonProps",
+ "canonicalReference": "@fluentui/react!IButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "contentButtonProps",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreePropsBase#expandButtonProps:member",
+ "docComment": "/**\n * Override props to customize the expand/collapse button (including its styles).\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "expandButtonProps?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ExpandIconButtonProps",
+ "canonicalReference": "@essex/components!ExpandIconButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "expandButtonProps",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreePropsBase#menuButtonProps:member",
+ "docComment": "/**\n * Override props for the right-side menu item for each item (if they have menuItems).\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "menuButtonProps?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "MenuButtonProps",
+ "canonicalReference": "@essex/components!MenuButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "menuButtonProps",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreePropsBase#narrow:member",
+ "docComment": "/**\n * Indicates that the Tree should be rendered in a narrow mode\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "narrow?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "narrow",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreePropsBase#size:member",
+ "docComment": "/**\n * Set the size mode of the tree\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "size",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/components!TreePropsBase#styles:member",
+ "docComment": "/**\n * General styles for customizing the tree.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "styles?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "TreeStyles",
+ "canonicalReference": "@essex/components!TreeStyles:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "styles",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useButtonProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useButtonProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IButtonProps",
+ "canonicalReference": "@fluentui/react!IButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IButtonProps",
+ "canonicalReference": "@fluentui/react!IButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useButtonProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useCheckboxProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useCheckboxProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ICheckboxProps",
+ "canonicalReference": "@fluentui/react!ICheckboxProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ICheckboxProps",
+ "canonicalReference": "@fluentui/react!ICheckboxProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useCheckboxProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useChoiceGroupProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useChoiceGroupProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IChoiceGroupProps",
+ "canonicalReference": "@fluentui/react!IChoiceGroupProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IChoiceGroupProps",
+ "canonicalReference": "@fluentui/react!IChoiceGroupProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useChoiceGroupProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useColorPickerProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useColorPickerProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IColorPickerProps",
+ "canonicalReference": "@fluentui/react!IColorPickerProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IColorPickerProps",
+ "canonicalReference": "@fluentui/react!IColorPickerProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useColorPickerProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useDropdownProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useDropdownProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IDropdownProps",
+ "canonicalReference": "@fluentui/react!IDropdownProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IDropdownProps",
+ "canonicalReference": "@fluentui/react!IDropdownProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useDropdownProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useIconButtonProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useIconButtonProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IButtonProps",
+ "canonicalReference": "@fluentui/react!IButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "IButtonProps",
+ "canonicalReference": "@fluentui/react!IButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 5,
+ "endIndex": 6
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useIconButtonProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useLabelProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useLabelProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ILabelProps",
+ "canonicalReference": "@fluentui/react!ILabelProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ILabelProps",
+ "canonicalReference": "@fluentui/react!ILabelProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useLabelProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useNavProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useNavProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "INavProps",
+ "canonicalReference": "@fluentui/react!INavProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "INavProps",
+ "canonicalReference": "@fluentui/react!INavProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useNavProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!usePivotProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function usePivotProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IPivotProps",
+ "canonicalReference": "@fluentui/react!IPivotProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IPivotProps",
+ "canonicalReference": "@fluentui/react!IPivotProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "usePivotProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useSliderProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useSliderProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ISliderProps",
+ "canonicalReference": "@fluentui/react!ISliderProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ISliderProps",
+ "canonicalReference": "@fluentui/react!ISliderProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useSliderProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useSpinButtonProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useSpinButtonProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ISpinButtonProps",
+ "canonicalReference": "@fluentui/react!ISpinButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ISpinButtonProps",
+ "canonicalReference": "@fluentui/react!ISpinButtonProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useSpinButtonProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useTextFieldProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useTextFieldProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ITextFieldProps",
+ "canonicalReference": "@fluentui/react!ITextFieldProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "ITextFieldProps",
+ "canonicalReference": "@fluentui/react!ITextFieldProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useTextFieldProps"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/components!useToggleProps:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useToggleProps(props: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IToggleProps",
+ "canonicalReference": "@fluentui/react!IToggleProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ", size?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Size",
+ "canonicalReference": "@essex/components!Size:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IToggleProps",
+ "canonicalReference": "@fluentui/react!IToggleProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 12
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "props",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "size",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useToggleProps"
+ }
+ ]
+ }
+ ]
+}
diff --git a/packages/components/docs/report/components.api.md b/packages/components/docs/report/components.api.md
new file mode 100644
index 00000000..d9121983
--- /dev/null
+++ b/packages/components/docs/report/components.api.md
@@ -0,0 +1,640 @@
+## API Report File for "@essex/components"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+///
+
+import type { CSSProperties } from 'react';
+import type { FC } from 'react';
+import type { IButtonProps } from '@fluentui/react';
+import type { ICheckboxProps } from '@fluentui/react';
+import type { IChoiceGroupProps } from '@fluentui/react';
+import type { IColorPickerProps } from '@fluentui/react';
+import type { ICommandBarStyleProps } from '@fluentui/react';
+import type { ICommandBarStyles } from '@fluentui/react';
+import type { IContextualMenuItem } from '@fluentui/react';
+import type { IContextualMenuItemStyles } from '@fluentui/react';
+import type { IContextualMenuListProps } from '@fluentui/react';
+import type { IContextualMenuProps } from '@fluentui/react';
+import type { IDropdownOption } from '@fluentui/react';
+import type { IDropdownProps } from '@fluentui/react';
+import type { IIconProps } from '@fluentui/react';
+import type { ILabelProps } from '@fluentui/react';
+import type { ILinkProps } from '@fluentui/react';
+import type { INavProps } from '@fluentui/react';
+import type { IPivotProps } from '@fluentui/react';
+import type { IRenderFunction } from '@fluentui/react';
+import type { ISliderProps } from '@fluentui/react';
+import type { ISpinButtonProps } from '@fluentui/react';
+import type { IStyleFunctionOrObject } from '@fluentui/react';
+import type { ITextFieldProps } from '@fluentui/react';
+import type { IToggleProps } from '@fluentui/react';
+import type { Position } from '@fluentui/react';
+import type { PropsWithChildren } from 'react';
+import type { default as React_2 } from 'react';
+
+// Warning: (ae-missing-release-tag) "ButtonChoiceGroup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const ButtonChoiceGroup: React.FC;
+
+// Warning: (ae-missing-release-tag) "ClippedGraph" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const ClippedGraph: ({ data, width, height, clipped, percentile, gradient, gradientInterpolation, gradientBand, horizon, sparkline, }: ClippedGraphProps) => JSX.Element;
+
+// Warning: (ae-missing-release-tag) "ClippedGraphProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ClippedGraphProps {
+ clipped?: boolean;
+ data: number[];
+ gradient?: boolean;
+ gradientBand?: number;
+ gradientInterpolation?: number;
+ height: number;
+ horizon?: boolean;
+ percentile?: number;
+ sparkline?: boolean;
+ width: number;
+}
+
+// Warning: (ae-missing-release-tag) "CollapsiblePanel" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const CollapsiblePanel: React.FC>;
+
+// Warning: (ae-missing-release-tag) "CollapsiblePanelContainer" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const CollapsiblePanelContainer: React.FC>;
+
+// Warning: (ae-missing-release-tag) "CollapsiblePanelContainerProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface CollapsiblePanelContainerProps {
+ // (undocumented)
+ styles?: {
+ root?: CSSProperties;
+ };
+}
+
+// Warning: (ae-missing-release-tag) "CollapsiblePanelProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface CollapsiblePanelProps {
+ buttonProps?: IButtonProps;
+ defaultExpanded?: boolean;
+ duration?: number;
+ expanded?: boolean;
+ first?: boolean;
+ hideIcon?: boolean;
+ last?: boolean;
+ onHeaderClick?: () => void;
+ onIconClick?: () => void;
+ onRenderHeader?: IRenderFunction;
+ styles?: CollapsiblePanelStyles;
+ title?: string;
+}
+
+// Warning: (ae-missing-release-tag) "CollapsiblePanelStyles" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface CollapsiblePanelStyles {
+ content?: CSSProperties;
+ header?: CSSProperties;
+ root?: CSSProperties;
+ title?: CSSProperties;
+ titleContainer?: CSSProperties;
+}
+
+// Warning: (ae-missing-release-tag) "ColumnarMenu" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const ColumnarMenu: React.FC;
+
+// Warning: (ae-forgotten-export) The symbol "ColumnarMenuListProps" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "ColumnarMenuList" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const ColumnarMenuList: React.FC;
+
+// Warning: (ae-missing-release-tag) "ColumnarMenuProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ColumnarMenuProps extends IContextualMenuProps {
+ buttonProps?: IButtonProps;
+ // (undocumented)
+ menuListProps?: Partial;
+ text?: string;
+}
+
+// Warning: (ae-missing-release-tag) "ControlledHistogramFilter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const ControlledHistogramFilter: ({ name, data, width, height, selectedRange, onChange, selectedFill, unselectedFill, }: ControlledHistogramFilterProps) => JSX.Element;
+
+// Warning: (ae-missing-release-tag) "ControlledHistogramFilterProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ControlledHistogramFilterProps {
+ // (undocumented)
+ data: number[];
+ // (undocumented)
+ height: number;
+ // (undocumented)
+ name: string;
+ // (undocumented)
+ onChange?: (range: [number | undefined, number | undefined]) => any;
+ // (undocumented)
+ selectedFill?: string;
+ // (undocumented)
+ selectedRange: [number | undefined, number | undefined];
+ // (undocumented)
+ unselectedFill?: string;
+ // (undocumented)
+ width: number;
+}
+
+// @public
+export type CookieConsent = Record;
+
+// @public
+export type CookieConsentBannerThemes = 'light' | 'dark' | 'high-contrast';
+
+// @public (undocumented)
+export enum CookieConsentCategories {
+ Advertising = "Advertising",
+ Analytics = "Analytics",
+ Required = "Required",
+ SocialMedia = "SocialMedia"
+}
+
+// Warning: (ae-internal-missing-underscore) The name "CookieConsentManager" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
+export type CookieConsentManager = {
+ readonly isConsentRequired: boolean;
+ getConsent(): CookieConsent;
+ getConsentFor(consentCategory: CookieConsentCategories): boolean;
+ manageConsent(): void;
+};
+
+// Warning: (ae-missing-release-tag) "defaultBannerLinks" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const defaultBannerLinks: Array;
+
+// Warning: (ae-missing-release-tag) "DialogConfirm" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const DialogConfirm: React.FC<{
+ toggle: () => void;
+ onConfirm: () => void;
+ show?: boolean;
+ title: string;
+ subText?: string;
+}>;
+
+// Warning: (ae-missing-release-tag) "EnumButtonBar" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function EnumButtonBar({ enumeration, selected, onChange, styles, iconNames, iconOnly, }: EnumButtonBarProps): JSX.Element;
+
+// Warning: (ae-missing-release-tag) "EnumButtonBarProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EnumButtonBarProps {
+ // (undocumented)
+ enumeration: any;
+ iconNames?: string[];
+ // (undocumented)
+ iconOnly?: boolean;
+ // (undocumented)
+ onChange?: (selected: string | number) => void;
+ // (undocumented)
+ selected?: E;
+ // (undocumented)
+ styles?: IStyleFunctionOrObject;
+}
+
+// Warning: (ae-missing-release-tag) "EnumDropdown" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const EnumDropdown: React.FC;
+
+// Warning: (ae-missing-release-tag) "EnumDropdownProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface EnumDropdownProps extends Omit {
+ // (undocumented)
+ enumeration: E;
+ labels?: Record;
+}
+
+// Warning: (ae-missing-release-tag) "Expando" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const Expando: FC>;
+
+// Warning: (ae-missing-release-tag) "ExpandoProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ExpandoProps {
+ defaultExpanded?: boolean;
+ iconButtonProps?: IButtonProps;
+ label: string;
+ linkProps?: ILinkProps;
+ styles?: ExpandoStyles;
+}
+
+// Warning: (ae-missing-release-tag) "ExpandoStyles" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ExpandoStyles {
+ content?: CSSProperties;
+ expando?: CSSProperties;
+ root?: CSSProperties;
+}
+
+// Warning: (ae-missing-release-tag) "FilterTextbox" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const FilterTextbox: ({ label, includePlaceholder, excludePlaceholder, onFilter, }: FilterTextboxProps) => JSX.Element;
+
+// Warning: (ae-missing-release-tag) "FilterTextboxProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface FilterTextboxProps {
+ excludePlaceholder?: string;
+ includePlaceholder?: string;
+ label?: string;
+ onFilter?: (text: string, exclude: boolean) => any;
+}
+
+// Warning: (ae-missing-release-tag) "getEnumDropdownOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function getEnumDropdownOptions>(enumeration: E, labels?: Record): IDropdownOption[];
+
+// Warning: (ae-missing-release-tag) "MultiDropdown" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const MultiDropdown: React.FC;
+
+// Warning: (ae-missing-release-tag) "MultiDropdownProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface MultiDropdownProps extends IDropdownProps {
+ // (undocumented)
+ onChangeAll?: (event: React.MouseEvent, options?: IDropdownOption[], indexes?: number[]) => void;
+}
+
+// Warning: (ae-missing-release-tag) "NumberSpinButton" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const NumberSpinButton: ({ label, value, min, max, step, onChange, labelPosition, incrementButtonAriaLabel, decrementButtonAriaLabel, }: NumberSpinButtonProps) => JSX.Element;
+
+// Warning: (ae-missing-release-tag) "NumberSpinButtonProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface NumberSpinButtonProps {
+ // (undocumented)
+ decrementButtonAriaLabel?: string;
+ // (undocumented)
+ incrementButtonAriaLabel?: string;
+ // (undocumented)
+ label: string;
+ // (undocumented)
+ labelPosition?: Position;
+ // (undocumented)
+ max?: number;
+ // (undocumented)
+ min?: number;
+ // (undocumented)
+ onChange?: (n: number) => any;
+ // (undocumented)
+ step?: number;
+ // (undocumented)
+ value: number;
+}
+
+// Warning: (ae-missing-release-tag) "PolicyAndCookieBanner" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const PolicyAndCookieBanner: FC;
+
+// @public
+export type PolicyAndCookieBannerProps = {
+ language?: string;
+ theme?: CookieConsentBannerThemes;
+ onConsentChange?: (newConsent: CookieConsent) => void;
+ onError: (error: unknown) => void;
+ className?: string;
+ styles?: CSSProperties;
+ links?: Array;
+};
+
+// @public (undocumented)
+export type PolicyLinkDetails = {
+ name: string;
+ href: string;
+};
+
+// Warning: (ae-internal-missing-underscore) The name "PolicyLinkProps" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
+export type PolicyLinkProps = {
+ name: string;
+ id?: string;
+ href?: string;
+ onClick?: () => void;
+ divider?: boolean;
+};
+
+// Warning: (ae-missing-release-tag) "ReadOnlyTextField" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const ReadOnlyTextField: React.FC;
+
+// Warning: (ae-missing-release-tag) "SearchBox" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const SearchBox: ({ defaultValue, label, placeholder, errorMessage, onSearch, }: SearchBoxProps) => JSX.Element;
+
+// Warning: (ae-missing-release-tag) "SearchBoxProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface SearchBoxProps {
+ defaultValue?: string;
+ errorMessage?: string;
+ label?: string;
+ onSearch?: (query: string) => any;
+ placeholder?: string;
+}
+
+// Warning: (ae-missing-release-tag) "Settings" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const Settings: ({ settings, config, groups, onChange, }: SettingsProps) => JSX.Element;
+
+// Warning: (ae-missing-release-tag) "SettingsGroup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface SettingsGroup {
+ // (undocumented)
+ keys: string[];
+ // (undocumented)
+ label?: string;
+}
+
+// Warning: (ae-missing-release-tag) "SettingsProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface SettingsProps {
+ config?: {
+ [key: string]: SettingConfig;
+ };
+ groups?: SettingsGroup[];
+ onChange?: (key: string, value: any) => void;
+ settings: any;
+}
+
+// Warning: (ae-missing-release-tag) "Size" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type Size = 'small' | 'medium';
+
+// Warning: (ae-missing-release-tag) "Sized" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface Sized {
+ // (undocumented)
+ size?: Size;
+}
+
+// Warning: (ae-missing-release-tag) "ToggleLink" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const ToggleLink: React.FC;
+
+// Warning: (ae-missing-release-tag) "ToggleLinkProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ToggleLinkProps {
+ // (undocumented)
+ className?: string;
+ // (undocumented)
+ messages: [string, string];
+ // (undocumented)
+ onChange?: (toggled: boolean) => void;
+ // (undocumented)
+ style?: React.CSSProperties;
+}
+
+// Warning: (ae-missing-release-tag) "ToolPanel" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const ToolPanel: React.FC>;
+
+// Warning: (ae-missing-release-tag) "ToolPanelProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ToolPanelProps {
+ // (undocumented)
+ closeIconProps?: IIconProps;
+ // (undocumented)
+ hasCloseButton?: boolean;
+ // (undocumented)
+ headerIconProps?: IIconProps;
+ // (undocumented)
+ headerText?: string;
+ // (undocumented)
+ onDismiss?: () => void;
+ // (undocumented)
+ styles?: ToolPanelStyles;
+}
+
+// Warning: (ae-missing-release-tag) "ToolPanelStyles" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ToolPanelStyles {
+ // (undocumented)
+ content?: React_2.CSSProperties;
+ // (undocumented)
+ header?: React_2.CSSProperties;
+ // (undocumented)
+ root?: React_2.CSSProperties;
+ // (undocumented)
+ title?: React_2.CSSProperties;
+ // (undocumented)
+ titleContainer?: React_2.CSSProperties;
+}
+
+// Warning: (ae-missing-release-tag) "Tree" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const Tree: React.FC;
+
+// Warning: (ae-missing-release-tag) "TreeGroup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface TreeGroup {
+ // (undocumented)
+ key: string;
+ // (undocumented)
+ text?: string;
+}
+
+// Warning: (ae-missing-release-tag) "TreeGroupProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface TreeGroupProps {
+ // (undocumented)
+ group: TreeGroup;
+ // (undocumented)
+ onRenderGroupHeader?: IRenderFunction;
+ // (undocumented)
+ size?: Size;
+ // Warning: (ae-forgotten-export) The symbol "TreeStyles" needs to be exported by the entry point index.d.ts
+ //
+ // (undocumented)
+ styles?: TreeStyles;
+}
+
+// Warning: (ae-missing-release-tag) "TreeItem" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface TreeItem {
+ children?: TreeItem[];
+ depth?: number;
+ expanded?: boolean;
+ group?: string;
+ iconName?: string;
+ // (undocumented)
+ key: string;
+ menuItems?: IContextualMenuItem[];
+ onClick?: (item: TreeItem) => void;
+ onExpand?: (item: TreeItem) => void;
+ onRenderContent?: IRenderFunction;
+ onRenderTitle?: IRenderFunction;
+ selected?: boolean;
+ // (undocumented)
+ text?: string;
+}
+
+// Warning: (ae-missing-release-tag) "TreeItemProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface TreeItemProps extends TreePropsBase {
+ // (undocumented)
+ item: TreeItem;
+}
+
+// Warning: (ae-missing-release-tag) "TreeProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface TreeProps extends TreePropsBase {
+ groups?: TreeGroup[];
+ items: TreeItem[];
+ onItemClick?: (item: TreeItem) => void;
+ onItemExpandClick?: (item: TreeItem) => void;
+ onRenderGroupHeader?: IRenderFunction;
+ selectedKey?: string;
+}
+
+// Warning: (ae-missing-release-tag) "TreePropsBase" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface TreePropsBase {
+ contentButtonProps?: IButtonProps;
+ // Warning: (ae-forgotten-export) The symbol "ExpandIconButtonProps" needs to be exported by the entry point index.d.ts
+ expandButtonProps?: ExpandIconButtonProps;
+ // Warning: (ae-forgotten-export) The symbol "MenuButtonProps" needs to be exported by the entry point index.d.ts
+ menuButtonProps?: MenuButtonProps;
+ narrow?: boolean;
+ size?: Size;
+ styles?: TreeStyles;
+}
+
+// Warning: (ae-missing-release-tag) "useButtonProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useButtonProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "useCheckboxProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useCheckboxProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "useChoiceGroupProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useChoiceGroupProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "useColorPickerProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useColorPickerProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "useDropdownProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useDropdownProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "useIconButtonProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useIconButtonProps(props: IButtonProps, size?: Size): IButtonProps;
+
+// Warning: (ae-missing-release-tag) "useLabelProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useLabelProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "useNavProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useNavProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "usePivotProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function usePivotProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "useSliderProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useSliderProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "useSpinButtonProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useSpinButtonProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "useTextFieldProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useTextFieldProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-missing-release-tag) "useToggleProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function useToggleProps(props: Partial, size?: Size): Partial;
+
+// Warning: (ae-internal-missing-underscore) The name "WcpConsent" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
+export type WcpConsent = {
+ init: (culture: string, placeholderIdOrElement: string | HTMLElement, initCallback?: (err?: Error, siteConsent?: CookieConsentManager) => void, onConsentChanged?: (newConsent: CookieConsent) => void, theme?: CookieConsentBannerThemes, stylesNonce?: string) => void;
+};
+
+// Warnings were encountered during analysis:
+//
+// dist/Settings/Settings.types.d.ts:97:9 - (ae-forgotten-export) The symbol "SettingConfig" needs to be exported by the entry point index.d.ts
+
+// (No @packageDocumentation comment for this package)
+
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.appbuilder._constructor_.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.appbuilder._constructor_.md
new file mode 100644
index 00000000..d970f2e8
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.appbuilder._constructor_.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [AppBuilder](./graphql-api-commons.appbuilder.md) > [(constructor)](./graphql-api-commons.appbuilder._constructor_.md)
+
+## AppBuilder.(constructor)
+
+Constructs a new instance of the `AppBuilder` class
+
+Signature:
+
+```typescript
+constructor(_appContext: Context, _logger: Logger, _schema: GraphQLSchema, _requestContextProviders: Array>);
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| \_appContext | Context | |
+| \_logger | Logger | |
+| \_schema | GraphQLSchema | |
+| \_requestContextProviders | Array<[RequestContextProvider](./graphql-api-commons.requestcontextprovider.md)<Configuration, Components, RequestContext>> | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.appbuilder.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.appbuilder.md
new file mode 100644
index 00000000..04616d24
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.appbuilder.md
@@ -0,0 +1,24 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [AppBuilder](./graphql-api-commons.appbuilder.md)
+
+## AppBuilder class
+
+Signature:
+
+```typescript
+export declare class AppBuilder, RequestContext>
+```
+
+## Constructors
+
+| Constructor | Modifiers | Description |
+| --- | --- | --- |
+| [(constructor)(\_appContext, \_logger, \_schema, \_requestContextProviders)](./graphql-api-commons.appbuilder._constructor_.md) | | Constructs a new instance of the AppBuilder class |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [start(preRun)](./graphql-api-commons.appbuilder.start.md) | | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.appbuilder.start.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.appbuilder.start.md
new file mode 100644
index 00000000..4fab6a0a
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.appbuilder.start.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [AppBuilder](./graphql-api-commons.appbuilder.md) > [start](./graphql-api-commons.appbuilder.start.md)
+
+## AppBuilder.start() method
+
+Signature:
+
+```typescript
+start(preRun?: PreRunCb): Promise;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| preRun | [PreRunCb](./graphql-api-commons.preruncb.md) | (Optional) |
+
+Returns:
+
+Promise<void>
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.attachdirectiveresolvers.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.attachdirectiveresolvers.md
new file mode 100644
index 00000000..092fb0ce
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.attachdirectiveresolvers.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [attachDirectiveResolvers](./graphql-api-commons.attachdirectiveresolvers.md)
+
+## attachDirectiveResolvers() function
+
+Signature:
+
+```typescript
+export declare function attachDirectiveResolvers(schema: GraphQLSchema, directiveResolvers: Record): GraphQLSchema;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| schema | GraphQLSchema | |
+| directiveResolvers | Record<string, ResolverType> | |
+
+Returns:
+
+GraphQLSchema
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.baseinjectornames.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.baseinjectornames.md
new file mode 100644
index 00000000..b4f939ce
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.baseinjectornames.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [BaseInjectorNames](./graphql-api-commons.baseinjectornames.md)
+
+## BaseInjectorNames variable
+
+Signature:
+
+```typescript
+BaseInjectorNames: {
+ AppContext: symbol;
+ AppBuilder: symbol;
+ Logger: symbol;
+ Schema: symbol;
+ Configuration: symbol;
+ RequestContextProviders: symbol;
+}
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.getschema.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.getschema.md
new file mode 100644
index 00000000..b1883710
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.getschema.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [getSchema](./graphql-api-commons.getschema.md)
+
+## getSchema() function
+
+Signature:
+
+```typescript
+export declare function getSchema(resolvedPath: string): string;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| resolvedPath | string | |
+
+Returns:
+
+string
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.iauthenticator.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.iauthenticator.md
new file mode 100644
index 00000000..e7f51a6d
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.iauthenticator.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IAuthenticator](./graphql-api-commons.iauthenticator.md)
+
+## IAuthenticator interface
+
+Common authenticator interface
+
+Signature:
+
+```typescript
+export interface IAuthenticator
+```
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| [login(credentials)](./graphql-api-commons.iauthenticator.login.md) | Log into the system with some credentials |
+| [logout()](./graphql-api-commons.iauthenticator.logout.md) | Log out of the system |
+| [verifyToken(token)](./graphql-api-commons.iauthenticator.verifytoken.md) | Log into the system with a JWT token |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.iauthenticator.verifytoken.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.iauthenticator.verifytoken.md
new file mode 100644
index 00000000..36955fc7
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.iauthenticator.verifytoken.md
@@ -0,0 +1,24 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IAuthenticator](./graphql-api-commons.iauthenticator.md) > [verifyToken](./graphql-api-commons.iauthenticator.verifytoken.md)
+
+## IAuthenticator.verifyToken() method
+
+Log into the system with a JWT token
+
+Signature:
+
+```typescript
+verifyToken(token: string | null): Promise;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| token | string \| null | The token to use |
+
+Returns:
+
+Promise<Identity \| null>
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.md
new file mode 100644
index 00000000..72cc7f29
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IBaseConfiguration](./graphql-api-commons.ibaseconfiguration.md)
+
+## IBaseConfiguration interface
+
+Signature:
+
+```typescript
+export interface IBaseConfiguration
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [loggingPretty](./graphql-api-commons.ibaseconfiguration.loggingpretty.md) | | boolean | Whether to prettify logger output |
+| [serverIntrospection](./graphql-api-commons.ibaseconfiguration.serverintrospection.md) | | boolean | Whether to enable GraphQL introspection |
+| [serverPlayground](./graphql-api-commons.ibaseconfiguration.serverplayground.md) | | boolean | Whether or not to present the GraphQL Playground |
+| [serverPort](./graphql-api-commons.ibaseconfiguration.serverport.md) | | number | The port the server will run on |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.serverintrospection.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.serverintrospection.md
new file mode 100644
index 00000000..91ff9e46
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.serverintrospection.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IBaseConfiguration](./graphql-api-commons.ibaseconfiguration.md) > [serverIntrospection](./graphql-api-commons.ibaseconfiguration.serverintrospection.md)
+
+## IBaseConfiguration.serverIntrospection property
+
+Whether to enable GraphQL introspection
+
+Signature:
+
+```typescript
+serverIntrospection: boolean;
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.serverplayground.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.serverplayground.md
new file mode 100644
index 00000000..3d9f5d44
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.serverplayground.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IBaseConfiguration](./graphql-api-commons.ibaseconfiguration.md) > [serverPlayground](./graphql-api-commons.ibaseconfiguration.serverplayground.md)
+
+## IBaseConfiguration.serverPlayground property
+
+Whether or not to present the GraphQL Playground
+
+Signature:
+
+```typescript
+serverPlayground: boolean;
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.serverport.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.serverport.md
new file mode 100644
index 00000000..48431dcc
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibaseconfiguration.serverport.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IBaseConfiguration](./graphql-api-commons.ibaseconfiguration.md) > [serverPort](./graphql-api-commons.ibaseconfiguration.serverport.md)
+
+## IBaseConfiguration.serverPort property
+
+The port the server will run on
+
+Signature:
+
+```typescript
+serverPort: number;
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibuiltappcontext.components.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibuiltappcontext.components.md
new file mode 100644
index 00000000..886a7984
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibuiltappcontext.components.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IBuiltAppContext](./graphql-api-commons.ibuiltappcontext.md) > [components](./graphql-api-commons.ibuiltappcontext.components.md)
+
+## IBuiltAppContext.components property
+
+Signature:
+
+```typescript
+components: Components;
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibuiltappcontext.configuration.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibuiltappcontext.configuration.md
new file mode 100644
index 00000000..986f4291
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibuiltappcontext.configuration.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IBuiltAppContext](./graphql-api-commons.ibuiltappcontext.md) > [configuration](./graphql-api-commons.ibuiltappcontext.configuration.md)
+
+## IBuiltAppContext.configuration property
+
+Signature:
+
+```typescript
+configuration: Configuration;
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibuiltappcontext.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibuiltappcontext.md
new file mode 100644
index 00000000..76011ef1
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.ibuiltappcontext.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IBuiltAppContext](./graphql-api-commons.ibuiltappcontext.md)
+
+## IBuiltAppContext interface
+
+Signature:
+
+```typescript
+export interface IBuiltAppContext
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [components](./graphql-api-commons.ibuiltappcontext.components.md) | | Components | |
+| [configuration](./graphql-api-commons.ibuiltappcontext.configuration.md) | | Configuration | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontext.identity.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontext.identity.md
new file mode 100644
index 00000000..47e3d9ce
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontext.identity.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IdentityRequestContext](./graphql-api-commons.identityrequestcontext.md) > [identity](./graphql-api-commons.identityrequestcontext.identity.md)
+
+## IdentityRequestContext.identity property
+
+Signature:
+
+```typescript
+identity: Identity | null;
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontext.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontext.md
new file mode 100644
index 00000000..9a084cb9
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontext.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IdentityRequestContext](./graphql-api-commons.identityrequestcontext.md)
+
+## IdentityRequestContext interface
+
+Signature:
+
+```typescript
+export interface IdentityRequestContext
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [identity](./graphql-api-commons.identityrequestcontext.identity.md) | | Identity \| null | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontextprovider._constructor_.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontextprovider._constructor_.md
new file mode 100644
index 00000000..b9b75fb8
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontextprovider._constructor_.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IdentityRequestContextProvider](./graphql-api-commons.identityrequestcontextprovider.md) > [(constructor)](./graphql-api-commons.identityrequestcontextprovider._constructor_.md)
+
+## IdentityRequestContextProvider.(constructor)
+
+Constructs a new instance of the `IdentityRequestContextProvider` class
+
+Signature:
+
+```typescript
+constructor(headerName?: string, headerTransformer?: Transformer);
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| headerName | string | (Optional) |
+| headerTransformer | [Transformer](./graphql-api-commons.transformer.md)<string \| null> | (Optional) |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontextprovider.apply.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontextprovider.apply.md
new file mode 100644
index 00000000..077b6b3e
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontextprovider.apply.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IdentityRequestContextProvider](./graphql-api-commons.identityrequestcontextprovider.md) > [apply](./graphql-api-commons.identityrequestcontextprovider.apply.md)
+
+## IdentityRequestContextProvider.apply() method
+
+Signature:
+
+```typescript
+apply(ctx: IRequestAppContext, request: IncomingMessage): Promise>;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| ctx | [IRequestAppContext](./graphql-api-commons.irequestappcontext.md)<Configuration, Components, RequestContext> | |
+| request | IncomingMessage | |
+
+Returns:
+
+Promise<Partial<RequestContext>>
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontextprovider.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontextprovider.md
new file mode 100644
index 00000000..125e25ea
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.identityrequestcontextprovider.md
@@ -0,0 +1,27 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IdentityRequestContextProvider](./graphql-api-commons.identityrequestcontextprovider.md)
+
+## IdentityRequestContextProvider class
+
+Signature:
+
+```typescript
+export declare class IdentityRequestContextProvider;
+}, RequestContext extends IdentityRequestContext, Identity> implements RequestContextProvider
+```
+Implements: [RequestContextProvider](./graphql-api-commons.requestcontextprovider.md)<Configuration, Components, RequestContext>
+
+## Constructors
+
+| Constructor | Modifiers | Description |
+| --- | --- | --- |
+| [(constructor)(headerName, headerTransformer)](./graphql-api-commons.identityrequestcontextprovider._constructor_.md) | | Constructs a new instance of the IdentityRequestContextProvider class |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [apply(ctx, request)](./graphql-api-commons.identityrequestcontextprovider.apply.md) | | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.irequestappcontext.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.irequestappcontext.md
new file mode 100644
index 00000000..b4091402
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.irequestappcontext.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IRequestAppContext](./graphql-api-commons.irequestappcontext.md)
+
+## IRequestAppContext interface
+
+Signature:
+
+```typescript
+export interface IRequestAppContext extends IBuiltAppContext
+```
+Extends: [IBuiltAppContext](./graphql-api-commons.ibuiltappcontext.md)<Configuration, Components>
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [request](./graphql-api-commons.irequestappcontext.request.md) | | RequestContext | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.irequestappcontext.request.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.irequestappcontext.request.md
new file mode 100644
index 00000000..41d6628f
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.irequestappcontext.request.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [IRequestAppContext](./graphql-api-commons.irequestappcontext.md) > [request](./graphql-api-commons.irequestappcontext.request.md)
+
+## IRequestAppContext.request property
+
+Signature:
+
+```typescript
+request: RequestContext;
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.md
new file mode 100644
index 00000000..ca66eead
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.md
@@ -0,0 +1,52 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md)
+
+## graphql-api-commons package
+
+## Classes
+
+| Class | Description |
+| --- | --- |
+| [AppBuilder](./graphql-api-commons.appbuilder.md) | |
+| [IdentityRequestContextProvider](./graphql-api-commons.identityrequestcontextprovider.md) | |
+| [LoggerProvider](./graphql-api-commons.loggerprovider.md) | |
+| [Server](./graphql-api-commons.server.md) | |
+
+## Functions
+
+| Function | Description |
+| --- | --- |
+| [attachDirectiveResolvers(schema, directiveResolvers)](./graphql-api-commons.attachdirectiveresolvers.md) | |
+| [getSchema(resolvedPath)](./graphql-api-commons.getschema.md) | |
+| [registerAppBuilder(ctx)](./graphql-api-commons.registerappbuilder.md) | |
+| [registerLogger(ctx)](./graphql-api-commons.registerlogger.md) | |
+| [registerRequestContextProviders(providers, ctx)](./graphql-api-commons.registerrequestcontextproviders.md) | |
+| [registerSchema(schema, ctx)](./graphql-api-commons.registerschema.md) | |
+
+## Interfaces
+
+| Interface | Description |
+| --- | --- |
+| [IAuthenticator](./graphql-api-commons.iauthenticator.md) | Common authenticator interface |
+| [IBaseConfiguration](./graphql-api-commons.ibaseconfiguration.md) | |
+| [IBuiltAppContext](./graphql-api-commons.ibuiltappcontext.md) | |
+| [IdentityRequestContext](./graphql-api-commons.identityrequestcontext.md) | |
+| [IRequestAppContext](./graphql-api-commons.irequestappcontext.md) | |
+| [Provider](./graphql-api-commons.provider.md) | |
+| [RequestContextProvider](./graphql-api-commons.requestcontextprovider.md) | |
+
+## Variables
+
+| Variable | Description |
+| --- | --- |
+| [BaseInjectorNames](./graphql-api-commons.baseinjectornames.md) | |
+| [stripBearerPrefix](./graphql-api-commons.stripbearerprefix.md) | |
+
+## Type Aliases
+
+| Type Alias | Description |
+| --- | --- |
+| [PreRunCb](./graphql-api-commons.preruncb.md) | |
+| [Transformer](./graphql-api-commons.transformer.md) | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.preruncb.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.preruncb.md
new file mode 100644
index 00000000..ec6ca2d8
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.preruncb.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [PreRunCb](./graphql-api-commons.preruncb.md)
+
+## PreRunCb type
+
+Signature:
+
+```typescript
+export type PreRunCb = (app: FastifyInstance) => Promise;
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.provider.get.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.provider.get.md
new file mode 100644
index 00000000..d4bdf3e9
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.provider.get.md
@@ -0,0 +1,15 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [Provider](./graphql-api-commons.provider.md) > [get](./graphql-api-commons.provider.get.md)
+
+## Provider.get() method
+
+Signature:
+
+```typescript
+get(): T;
+```
+Returns:
+
+T
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.provider.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.provider.md
new file mode 100644
index 00000000..99d887b0
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.provider.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [Provider](./graphql-api-commons.provider.md)
+
+## Provider interface
+
+Signature:
+
+```typescript
+export interface Provider
+```
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| [get()](./graphql-api-commons.provider.get.md) | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerappbuilder.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerappbuilder.md
new file mode 100644
index 00000000..491ea7c4
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerappbuilder.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [registerAppBuilder](./graphql-api-commons.registerappbuilder.md)
+
+## registerAppBuilder() function
+
+Signature:
+
+```typescript
+export declare function registerAppBuilder(ctx?: DependencyContainer): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| ctx | DependencyContainer | (Optional) |
+
+Returns:
+
+void
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerlogger.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerlogger.md
new file mode 100644
index 00000000..bfb8889f
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerlogger.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [registerLogger](./graphql-api-commons.registerlogger.md)
+
+## registerLogger() function
+
+Signature:
+
+```typescript
+export declare function registerLogger(ctx?: DependencyContainer): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| ctx | DependencyContainer | (Optional) |
+
+Returns:
+
+void
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerrequestcontextproviders.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerrequestcontextproviders.md
new file mode 100644
index 00000000..cc2cc8ff
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerrequestcontextproviders.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [registerRequestContextProviders](./graphql-api-commons.registerrequestcontextproviders.md)
+
+## registerRequestContextProviders() function
+
+Signature:
+
+```typescript
+export declare function registerRequestContextProviders(providers: RequestContextProvider[], ctx?: DependencyContainer): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| providers | [RequestContextProvider](./graphql-api-commons.requestcontextprovider.md)<any, unknown, unknown>\[\] | |
+| ctx | DependencyContainer | (Optional) |
+
+Returns:
+
+void
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerschema.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerschema.md
new file mode 100644
index 00000000..f89aab7b
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.registerschema.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [registerSchema](./graphql-api-commons.registerschema.md)
+
+## registerSchema() function
+
+Signature:
+
+```typescript
+export declare function registerSchema(schema: GraphQLSchema, ctx?: DependencyContainer): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| schema | GraphQLSchema | |
+| ctx | DependencyContainer | (Optional) |
+
+Returns:
+
+void
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.requestcontextprovider.apply.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.requestcontextprovider.apply.md
new file mode 100644
index 00000000..25910bbe
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.requestcontextprovider.apply.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [RequestContextProvider](./graphql-api-commons.requestcontextprovider.md) > [apply](./graphql-api-commons.requestcontextprovider.apply.md)
+
+## RequestContextProvider.apply() method
+
+Signature:
+
+```typescript
+apply(ctx: IRequestAppContext, request: IncomingMessage): Promise>;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| ctx | [IRequestAppContext](./graphql-api-commons.irequestappcontext.md)<Configuration, Components, RequestContext> | |
+| request | IncomingMessage | |
+
+Returns:
+
+Promise<Partial<RequestContext>>
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.requestcontextprovider.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.requestcontextprovider.md
new file mode 100644
index 00000000..3d9d8d33
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.requestcontextprovider.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [RequestContextProvider](./graphql-api-commons.requestcontextprovider.md)
+
+## RequestContextProvider interface
+
+Signature:
+
+```typescript
+export interface RequestContextProvider
+```
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| [apply(ctx, request)](./graphql-api-commons.requestcontextprovider.apply.md) | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.server._constructor_.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.server._constructor_.md
new file mode 100644
index 00000000..cf6a60ed
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.server._constructor_.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [Server](./graphql-api-commons.server.md) > [(constructor)](./graphql-api-commons.server._constructor_.md)
+
+## Server.(constructor)
+
+Constructs a new instance of the `Server` class
+
+Signature:
+
+```typescript
+constructor(_configuration: Configuration, _appBuilder: AppBuilder, _logger: Logger);
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| \_configuration | Configuration | |
+| \_appBuilder | [AppBuilder](./graphql-api-commons.appbuilder.md)<Configuration, Components, Context, RequestContext> | |
+| \_logger | Logger | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.server.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.server.md
new file mode 100644
index 00000000..01da2e38
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.server.md
@@ -0,0 +1,24 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [Server](./graphql-api-commons.server.md)
+
+## Server class
+
+Signature:
+
+```typescript
+export declare class Server, RequestContext>
+```
+
+## Constructors
+
+| Constructor | Modifiers | Description |
+| --- | --- | --- |
+| [(constructor)(\_configuration, \_appBuilder, \_logger)](./graphql-api-commons.server._constructor_.md) | | Constructs a new instance of the Server class |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [start(preRun)](./graphql-api-commons.server.start.md) | | |
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.server.start.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.server.start.md
new file mode 100644
index 00000000..51d04c7e
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.server.start.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [Server](./graphql-api-commons.server.md) > [start](./graphql-api-commons.server.start.md)
+
+## Server.start() method
+
+Signature:
+
+```typescript
+start(preRun?: PreRunCb): Promise;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| preRun | [PreRunCb](./graphql-api-commons.preruncb.md) | (Optional) |
+
+Returns:
+
+Promise<void>
+
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.stripbearerprefix.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.stripbearerprefix.md
new file mode 100644
index 00000000..908d0978
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.stripbearerprefix.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [stripBearerPrefix](./graphql-api-commons.stripbearerprefix.md)
+
+## stripBearerPrefix variable
+
+Signature:
+
+```typescript
+stripBearerPrefix: Transformer
+```
diff --git a/packages/graphql-api-commons/docs/markdown/graphql-api-commons.transformer.md b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.transformer.md
new file mode 100644
index 00000000..d7c1693f
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/graphql-api-commons.transformer.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/graphql-api-commons](./graphql-api-commons.md) > [Transformer](./graphql-api-commons.transformer.md)
+
+## Transformer type
+
+Signature:
+
+```typescript
+export type Transformer = (value: T) => T;
+```
diff --git a/packages/graphql-api-commons/docs/markdown/index.md b/packages/graphql-api-commons/docs/markdown/index.md
new file mode 100644
index 00000000..4683b3f1
--- /dev/null
+++ b/packages/graphql-api-commons/docs/markdown/index.md
@@ -0,0 +1,12 @@
+
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+| Package | Description |
+| --- | --- |
+| [@essex/graphql-api-commons](./graphql-api-commons.md) | |
+
diff --git a/packages/graphql-api-commons/docs/report/graphql-api-commons.api.json b/packages/graphql-api-commons/docs/report/graphql-api-commons.api.json
new file mode 100644
index 00000000..e315c7e1
--- /dev/null
+++ b/packages/graphql-api-commons/docs/report/graphql-api-commons.api.json
@@ -0,0 +1,2275 @@
+{
+ "metadata": {
+ "toolPackage": "@microsoft/api-extractor",
+ "toolVersion": "7.29.2",
+ "schemaVersion": 1009,
+ "oldestForwardsCompatibleVersion": 1001,
+ "tsdocConfig": {
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+ "noStandardTags": true,
+ "tagDefinitions": [
+ {
+ "tagName": "@alpha",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@beta",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@defaultValue",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@decorator",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@deprecated",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@eventProperty",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@example",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@experimental",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@inheritDoc",
+ "syntaxKind": "inline"
+ },
+ {
+ "tagName": "@internal",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@label",
+ "syntaxKind": "inline"
+ },
+ {
+ "tagName": "@link",
+ "syntaxKind": "inline",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@override",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@packageDocumentation",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@param",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@privateRemarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@public",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@readonly",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@remarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@returns",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@sealed",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@see",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@throws",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@typeParam",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@virtual",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@betaDocumentation",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@internalRemarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@preapproved",
+ "syntaxKind": "modifier"
+ }
+ ],
+ "supportForTags": {
+ "@alpha": true,
+ "@beta": true,
+ "@defaultValue": true,
+ "@decorator": true,
+ "@deprecated": true,
+ "@eventProperty": true,
+ "@example": true,
+ "@experimental": true,
+ "@inheritDoc": true,
+ "@internal": true,
+ "@label": true,
+ "@link": true,
+ "@override": true,
+ "@packageDocumentation": true,
+ "@param": true,
+ "@privateRemarks": true,
+ "@public": true,
+ "@readonly": true,
+ "@remarks": true,
+ "@returns": true,
+ "@sealed": true,
+ "@see": true,
+ "@throws": true,
+ "@typeParam": true,
+ "@virtual": true,
+ "@betaDocumentation": true,
+ "@internalRemarks": true,
+ "@preapproved": true
+ },
+ "reportUnsupportedHtmlElements": false
+ }
+ },
+ "kind": "Package",
+ "canonicalReference": "@essex/graphql-api-commons!",
+ "docComment": "",
+ "name": "@essex/graphql-api-commons",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "EntryPoint",
+ "canonicalReference": "@essex/graphql-api-commons!",
+ "name": "",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "Class",
+ "canonicalReference": "@essex/graphql-api-commons!AppBuilder:class",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare class AppBuilder"
+ },
+ {
+ "kind": "Content",
+ "text": ", RequestContext> "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "Configuration",
+ "constraintTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "Components",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "Context",
+ "constraintTokenRange": {
+ "startIndex": 3,
+ "endIndex": 5
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "RequestContext",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "AppBuilder",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "Constructor",
+ "canonicalReference": "@essex/graphql-api-commons!AppBuilder:constructor(1)",
+ "docComment": "/**\n * Constructs a new instance of the `AppBuilder` class\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "constructor(_appContext: "
+ },
+ {
+ "kind": "Content",
+ "text": "Context"
+ },
+ {
+ "kind": "Content",
+ "text": ", _logger: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Logger",
+ "canonicalReference": "pino!Logger:type"
+ },
+ {
+ "kind": "Content",
+ "text": ", _schema: "
+ },
+ {
+ "kind": "Reference",
+ "text": "GraphQLSchema",
+ "canonicalReference": "graphql!GraphQLSchema:class"
+ },
+ {
+ "kind": "Content",
+ "text": ", _requestContextProviders: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Array",
+ "canonicalReference": "!Array:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "RequestContextProvider",
+ "canonicalReference": "@essex/graphql-api-commons!RequestContextProvider:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ");"
+ }
+ ],
+ "releaseTag": "Public",
+ "isProtected": false,
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "_appContext",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "_logger",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "_schema",
+ "parameterTypeTokenRange": {
+ "startIndex": 5,
+ "endIndex": 6
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "_requestContextProviders",
+ "parameterTypeTokenRange": {
+ "startIndex": 7,
+ "endIndex": 11
+ },
+ "isOptional": false
+ }
+ ]
+ },
+ {
+ "kind": "Method",
+ "canonicalReference": "@essex/graphql-api-commons!AppBuilder#start:member(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "start(preRun?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "PreRunCb",
+ "canonicalReference": "@essex/graphql-api-commons!PreRunCb:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isStatic": false,
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 5
+ },
+ "releaseTag": "Public",
+ "isProtected": false,
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "preRun",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": true
+ }
+ ],
+ "isOptional": false,
+ "name": "start"
+ }
+ ],
+ "implementsTokenRanges": []
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/graphql-api-commons!attachDirectiveResolvers:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function attachDirectiveResolvers(schema: "
+ },
+ {
+ "kind": "Reference",
+ "text": "GraphQLSchema",
+ "canonicalReference": "graphql!GraphQLSchema:class"
+ },
+ {
+ "kind": "Content",
+ "text": ", directiveResolvers: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Record",
+ "canonicalReference": "!Record:type"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "GraphQLSchema",
+ "canonicalReference": "graphql!GraphQLSchema:class"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "schema",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "directiveResolvers",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 5
+ },
+ "isOptional": false
+ }
+ ],
+ "typeParameters": [
+ {
+ "typeParameterName": "ResolverType",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "attachDirectiveResolvers"
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/graphql-api-commons!BaseInjectorNames:var",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "BaseInjectorNames: "
+ },
+ {
+ "kind": "Content",
+ "text": "{\n AppContext: symbol;\n AppBuilder: symbol;\n Logger: symbol;\n Schema: symbol;\n Configuration: symbol;\n RequestContextProviders: symbol;\n}"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "BaseInjectorNames",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/graphql-api-commons!getSchema:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function getSchema(resolvedPath: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "resolvedPath",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ }
+ ],
+ "name": "getSchema"
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/graphql-api-commons!IAuthenticator:interface",
+ "docComment": "/**\n * Common authenticator interface\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IAuthenticator "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "Credentials",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "Identity",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "IAuthenticator",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "MethodSignature",
+ "canonicalReference": "@essex/graphql-api-commons!IAuthenticator#login:member(1)",
+ "docComment": "/**\n * Log into the system with some credentials\n *\n * @param credentials - The credentials to provide\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "login(credentials: "
+ },
+ {
+ "kind": "Content",
+ "text": "Credentials"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isOptional": false,
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 5
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "credentials",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ }
+ ],
+ "name": "login"
+ },
+ {
+ "kind": "MethodSignature",
+ "canonicalReference": "@essex/graphql-api-commons!IAuthenticator#logout:member(1)",
+ "docComment": "/**\n * Log out of the system\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "logout(): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isOptional": false,
+ "returnTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [],
+ "name": "logout"
+ },
+ {
+ "kind": "MethodSignature",
+ "canonicalReference": "@essex/graphql-api-commons!IAuthenticator#verifyToken:member(1)",
+ "docComment": "/**\n * Log into the system with a JWT token\n *\n * @param token - The token to use\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "verifyToken(token: "
+ },
+ {
+ "kind": "Content",
+ "text": "string | null"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isOptional": false,
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 5
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "token",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ }
+ ],
+ "name": "verifyToken"
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/graphql-api-commons!IBaseConfiguration:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IBaseConfiguration "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "IBaseConfiguration",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/graphql-api-commons!IBaseConfiguration#loggingPretty:member",
+ "docComment": "/**\n * Whether to prettify logger output\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "loggingPretty: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "loggingPretty",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/graphql-api-commons!IBaseConfiguration#serverIntrospection:member",
+ "docComment": "/**\n * Whether to enable GraphQL introspection\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "serverIntrospection: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "serverIntrospection",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/graphql-api-commons!IBaseConfiguration#serverPlayground:member",
+ "docComment": "/**\n * Whether or not to present the GraphQL Playground\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "serverPlayground: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "serverPlayground",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/graphql-api-commons!IBaseConfiguration#serverPort:member",
+ "docComment": "/**\n * The port the server will run on\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "serverPort: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "serverPort",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/graphql-api-commons!IBuiltAppContext:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IBuiltAppContext "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "Configuration",
+ "constraintTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "Components",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "IBuiltAppContext",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/graphql-api-commons!IBuiltAppContext#components:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "components: "
+ },
+ {
+ "kind": "Content",
+ "text": "Components"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "components",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/graphql-api-commons!IBuiltAppContext#configuration:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "configuration: "
+ },
+ {
+ "kind": "Content",
+ "text": "Configuration"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "configuration",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/graphql-api-commons!IdentityRequestContext:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IdentityRequestContext "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "Identity",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "IdentityRequestContext",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/graphql-api-commons!IdentityRequestContext#identity:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "identity: "
+ },
+ {
+ "kind": "Content",
+ "text": "Identity | null"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "identity",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Class",
+ "canonicalReference": "@essex/graphql-api-commons!IdentityRequestContextProvider:class",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare class IdentityRequestContextProvider;\n}"
+ },
+ {
+ "kind": "Content",
+ "text": ", RequestContext extends "
+ },
+ {
+ "kind": "Reference",
+ "text": "IdentityRequestContext",
+ "canonicalReference": "@essex/graphql-api-commons!IdentityRequestContext:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ", Identity> implements "
+ },
+ {
+ "kind": "Reference",
+ "text": "RequestContextProvider",
+ "canonicalReference": "@essex/graphql-api-commons!RequestContextProvider:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": " "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "Configuration",
+ "constraintTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "Components",
+ "constraintTokenRange": {
+ "startIndex": 3,
+ "endIndex": 6
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "RequestContext",
+ "constraintTokenRange": {
+ "startIndex": 7,
+ "endIndex": 9
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "Identity",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "IdentityRequestContextProvider",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "Constructor",
+ "canonicalReference": "@essex/graphql-api-commons!IdentityRequestContextProvider:constructor(1)",
+ "docComment": "/**\n * Constructs a new instance of the `IdentityRequestContextProvider` class\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "constructor(headerName?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ", headerTransformer?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Transformer",
+ "canonicalReference": "@essex/graphql-api-commons!Transformer:type"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ");"
+ }
+ ],
+ "releaseTag": "Public",
+ "isProtected": false,
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "headerName",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": true
+ },
+ {
+ "parameterName": "headerTransformer",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 5
+ },
+ "isOptional": true
+ }
+ ]
+ },
+ {
+ "kind": "Method",
+ "canonicalReference": "@essex/graphql-api-commons!IdentityRequestContextProvider#apply:member(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "apply(ctx: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IRequestAppContext",
+ "canonicalReference": "@essex/graphql-api-commons!IRequestAppContext:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ", request: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IncomingMessage",
+ "canonicalReference": "!\"\\\"http\\\"\".IncomingMessage:class"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isStatic": false,
+ "returnTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 10
+ },
+ "releaseTag": "Public",
+ "isProtected": false,
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "ctx",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "request",
+ "parameterTypeTokenRange": {
+ "startIndex": 4,
+ "endIndex": 5
+ },
+ "isOptional": false
+ }
+ ],
+ "isOptional": false,
+ "name": "apply"
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/graphql-api-commons!IdentityRequestContextProvider#authenticator:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "authenticator: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IAuthenticator",
+ "canonicalReference": "@essex/graphql-api-commons!IAuthenticator:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "authenticator",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ }
+ ],
+ "implementsTokenRanges": [
+ {
+ "startIndex": 10,
+ "endIndex": 12
+ }
+ ]
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/graphql-api-commons!IRequestAppContext:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IRequestAppContext extends "
+ },
+ {
+ "kind": "Reference",
+ "text": "IBuiltAppContext",
+ "canonicalReference": "@essex/graphql-api-commons!IBuiltAppContext:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": " "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "Configuration",
+ "constraintTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "Components",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "RequestContext",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "IRequestAppContext",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/graphql-api-commons!IRequestAppContext#request:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "request: "
+ },
+ {
+ "kind": "Content",
+ "text": "RequestContext"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "request",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": [
+ {
+ "startIndex": 3,
+ "endIndex": 5
+ }
+ ]
+ },
+ {
+ "kind": "Class",
+ "canonicalReference": "@essex/graphql-api-commons!LoggerProvider:class",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare class LoggerProvider implements "
+ },
+ {
+ "kind": "Reference",
+ "text": "Provider",
+ "canonicalReference": "@essex/graphql-api-commons!Provider:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "Logger",
+ "canonicalReference": "pino!Logger:type"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": " "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "TConfiguration",
+ "constraintTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "LoggerProvider",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "Constructor",
+ "canonicalReference": "@essex/graphql-api-commons!LoggerProvider:constructor(1)",
+ "docComment": "/**\n * Constructs a new instance of the `LoggerProvider` class\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "constructor(_config: "
+ },
+ {
+ "kind": "Content",
+ "text": "TConfiguration"
+ },
+ {
+ "kind": "Content",
+ "text": ");"
+ }
+ ],
+ "releaseTag": "Public",
+ "isProtected": false,
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "_config",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ }
+ ]
+ },
+ {
+ "kind": "Method",
+ "canonicalReference": "@essex/graphql-api-commons!LoggerProvider#get:member(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "get(): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Logger",
+ "canonicalReference": "pino!Logger:type"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isStatic": false,
+ "returnTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "releaseTag": "Public",
+ "isProtected": false,
+ "overloadIndex": 1,
+ "parameters": [],
+ "isOptional": false,
+ "name": "get"
+ }
+ ],
+ "implementsTokenRanges": [
+ {
+ "startIndex": 3,
+ "endIndex": 7
+ }
+ ]
+ },
+ {
+ "kind": "TypeAlias",
+ "canonicalReference": "@essex/graphql-api-commons!PreRunCb:type",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export type PreRunCb = "
+ },
+ {
+ "kind": "Content",
+ "text": "(app: "
+ },
+ {
+ "kind": "Reference",
+ "text": "FastifyInstance",
+ "canonicalReference": "fastify!FastifyInstance:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "PreRunCb",
+ "typeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 6
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/graphql-api-commons!Provider:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface Provider "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "T",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "Provider",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "MethodSignature",
+ "canonicalReference": "@essex/graphql-api-commons!Provider#get:member(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "get(): "
+ },
+ {
+ "kind": "Content",
+ "text": "T"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isOptional": false,
+ "returnTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [],
+ "name": "get"
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/graphql-api-commons!registerAppBuilder:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function registerAppBuilder(ctx?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "DependencyContainer",
+ "canonicalReference": "tsyringe!default:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "ctx",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "registerAppBuilder"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/graphql-api-commons!registerLogger:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function registerLogger(ctx?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "DependencyContainer",
+ "canonicalReference": "tsyringe!default:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "ctx",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "registerLogger"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/graphql-api-commons!registerRequestContextProviders:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function registerRequestContextProviders(providers: "
+ },
+ {
+ "kind": "Reference",
+ "text": "RequestContextProvider",
+ "canonicalReference": "@essex/graphql-api-commons!RequestContextProvider:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ", ctx?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "DependencyContainer",
+ "canonicalReference": "tsyringe!default:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "providers",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "ctx",
+ "parameterTypeTokenRange": {
+ "startIndex": 4,
+ "endIndex": 5
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "registerRequestContextProviders"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/graphql-api-commons!registerSchema:function(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function registerSchema(schema: "
+ },
+ {
+ "kind": "Reference",
+ "text": "GraphQLSchema",
+ "canonicalReference": "graphql!GraphQLSchema:class"
+ },
+ {
+ "kind": "Content",
+ "text": ", ctx?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "DependencyContainer",
+ "canonicalReference": "tsyringe!default:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 5,
+ "endIndex": 6
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "schema",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "ctx",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "registerSchema"
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/graphql-api-commons!RequestContextProvider:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface RequestContextProvider "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "Configuration",
+ "constraintTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "Components",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "RequestContext",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "RequestContextProvider",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "MethodSignature",
+ "canonicalReference": "@essex/graphql-api-commons!RequestContextProvider#apply:member(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "apply(ctx: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IRequestAppContext",
+ "canonicalReference": "@essex/graphql-api-commons!IRequestAppContext:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ", request: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IncomingMessage",
+ "canonicalReference": "!\"\\\"http\\\"\".IncomingMessage:class"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "Partial",
+ "canonicalReference": "!Partial:type"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isOptional": false,
+ "returnTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 10
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "ctx",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "request",
+ "parameterTypeTokenRange": {
+ "startIndex": 4,
+ "endIndex": 5
+ },
+ "isOptional": false
+ }
+ ],
+ "name": "apply"
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Class",
+ "canonicalReference": "@essex/graphql-api-commons!Server:class",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare class Server"
+ },
+ {
+ "kind": "Content",
+ "text": ", RequestContext> "
+ }
+ ],
+ "releaseTag": "Public",
+ "typeParameters": [
+ {
+ "typeParameterName": "Configuration",
+ "constraintTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "Components",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "Context",
+ "constraintTokenRange": {
+ "startIndex": 3,
+ "endIndex": 5
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "RequestContext",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "Server",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "Constructor",
+ "canonicalReference": "@essex/graphql-api-commons!Server:constructor(1)",
+ "docComment": "/**\n * Constructs a new instance of the `Server` class\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "constructor(_configuration: "
+ },
+ {
+ "kind": "Content",
+ "text": "Configuration"
+ },
+ {
+ "kind": "Content",
+ "text": ", _appBuilder: "
+ },
+ {
+ "kind": "Reference",
+ "text": "AppBuilder",
+ "canonicalReference": "@essex/graphql-api-commons!AppBuilder:class"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ", _logger: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Logger",
+ "canonicalReference": "pino!Logger:type"
+ },
+ {
+ "kind": "Content",
+ "text": ");"
+ }
+ ],
+ "releaseTag": "Public",
+ "isProtected": false,
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "_configuration",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "_appBuilder",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "_logger",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": false
+ }
+ ]
+ },
+ {
+ "kind": "Method",
+ "canonicalReference": "@essex/graphql-api-commons!Server#start:member(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "start(preRun?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "PreRunCb",
+ "canonicalReference": "@essex/graphql-api-commons!PreRunCb:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isStatic": false,
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 5
+ },
+ "releaseTag": "Public",
+ "isProtected": false,
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "preRun",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": true
+ }
+ ],
+ "isOptional": false,
+ "name": "start"
+ }
+ ],
+ "implementsTokenRanges": []
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/graphql-api-commons!stripBearerPrefix:var",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "stripBearerPrefix: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Transformer",
+ "canonicalReference": "@essex/graphql-api-commons!Transformer:type"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "stripBearerPrefix",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "TypeAlias",
+ "canonicalReference": "@essex/graphql-api-commons!Transformer:type",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export type Transformer = "
+ },
+ {
+ "kind": "Content",
+ "text": "(value: T) => T"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "Transformer",
+ "typeParameters": [
+ {
+ "typeParameterName": "T",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "typeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ]
+ }
+ ]
+}
diff --git a/packages/graphql-api-commons/docs/report/graphql-api-commons.api.md b/packages/graphql-api-commons/docs/report/graphql-api-commons.api.md
new file mode 100644
index 00000000..b9ba628d
--- /dev/null
+++ b/packages/graphql-api-commons/docs/report/graphql-api-commons.api.md
@@ -0,0 +1,173 @@
+## API Report File for "@essex/graphql-api-commons"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+///
+
+import type { DependencyContainer } from 'tsyringe';
+import type { FastifyInstance } from 'fastify';
+import { GraphQLSchema } from 'graphql';
+import { IncomingMessage } from 'http';
+import { Logger } from 'pino';
+
+// Warning: (ae-missing-release-tag) "AppBuilder" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export class AppBuilder, RequestContext> {
+ constructor(_appContext: Context, _logger: Logger, _schema: GraphQLSchema, _requestContextProviders: Array>);
+ // (undocumented)
+ start(preRun?: PreRunCb): Promise;
+}
+
+// Warning: (ae-missing-release-tag) "attachDirectiveResolvers" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function attachDirectiveResolvers(schema: GraphQLSchema, directiveResolvers: Record): GraphQLSchema;
+
+// Warning: (ae-missing-release-tag) "BaseInjectorNames" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const BaseInjectorNames: {
+ AppContext: symbol;
+ AppBuilder: symbol;
+ Logger: symbol;
+ Schema: symbol;
+ Configuration: symbol;
+ RequestContextProviders: symbol;
+};
+
+// Warning: (ae-missing-release-tag) "getSchema" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function getSchema(resolvedPath: string): string;
+
+// Warning: (ae-missing-release-tag) "IAuthenticator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export interface IAuthenticator {
+ login(credentials: Credentials): Promise;
+ logout(): Promise;
+ verifyToken(token: string | null): Promise;
+}
+
+// Warning: (ae-missing-release-tag) "IBaseConfiguration" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IBaseConfiguration {
+ loggingPretty: boolean;
+ serverIntrospection: boolean;
+ serverPlayground: boolean;
+ serverPort: number;
+}
+
+// Warning: (ae-missing-release-tag) "IBuiltAppContext" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IBuiltAppContext {
+ // (undocumented)
+ components: Components;
+ // (undocumented)
+ configuration: Configuration;
+}
+
+// Warning: (ae-missing-release-tag) "IdentityRequestContext" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IdentityRequestContext {
+ // (undocumented)
+ identity: Identity | null;
+}
+
+// Warning: (ae-missing-release-tag) "IdentityRequestContextProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export class IdentityRequestContextProvider;
+}, RequestContext extends IdentityRequestContext, Identity> implements RequestContextProvider {
+ constructor(headerName?: string, headerTransformer?: Transformer);
+ // (undocumented)
+ apply(ctx: IRequestAppContext, request: IncomingMessage): Promise>;
+}
+
+// Warning: (ae-missing-release-tag) "IRequestAppContext" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IRequestAppContext extends IBuiltAppContext {
+ // (undocumented)
+ request: RequestContext;
+}
+
+// Warning: (ae-missing-release-tag) "LoggerProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export class LoggerProvider implements Provider {
+ constructor(_config: TConfiguration);
+ // (undocumented)
+ get(): Logger;
+}
+
+// Warning: (ae-missing-release-tag) "PreRunCb" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type PreRunCb = (app: FastifyInstance) => Promise;
+
+// Warning: (ae-missing-release-tag) "Provider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface Provider {
+ // (undocumented)
+ get(): T;
+}
+
+// Warning: (ae-missing-release-tag) "registerAppBuilder" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function registerAppBuilder(ctx?: DependencyContainer): void;
+
+// Warning: (ae-missing-release-tag) "registerLogger" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function registerLogger(ctx?: DependencyContainer): void;
+
+// Warning: (ae-missing-release-tag) "registerRequestContextProviders" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function registerRequestContextProviders(providers: RequestContextProvider[], ctx?: DependencyContainer): void;
+
+// Warning: (ae-missing-release-tag) "registerSchema" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function registerSchema(schema: GraphQLSchema, ctx?: DependencyContainer): void;
+
+// Warning: (ae-missing-release-tag) "RequestContextProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface RequestContextProvider {
+ // (undocumented)
+ apply(ctx: IRequestAppContext, request: IncomingMessage): Promise>;
+}
+
+// Warning: (ae-missing-release-tag) "Server" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export class Server, RequestContext> {
+ constructor(_configuration: Configuration, _appBuilder: AppBuilder, _logger: Logger);
+ // (undocumented)
+ start(preRun?: PreRunCb): Promise;
+}
+
+// Warning: (ae-missing-release-tag) "stripBearerPrefix" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const stripBearerPrefix: Transformer;
+
+// Warning: (ae-missing-release-tag) "Transformer" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type Transformer = (value: T) => T;
+
+// (No @packageDocumentation comment for this package)
+
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.communityid.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.communityid.md
new file mode 100644
index 00000000..312772da
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.communityid.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [CommunityId](./hierarchy-browser.communityid.md)
+
+## CommunityId type
+
+Signature:
+
+```typescript
+export type CommunityId = string;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.entityid.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.entityid.md
new file mode 100644
index 00000000..9a711b8c
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.entityid.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [EntityId](./hierarchy-browser.entityid.md)
+
+## EntityId type
+
+Signature:
+
+```typescript
+export type EntityId = string;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.hierarchybrowser.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.hierarchybrowser.md
new file mode 100644
index 00000000..9f63511a
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.hierarchybrowser.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [HierarchyBrowser](./hierarchy-browser.hierarchybrowser.md)
+
+## HierarchyBrowser variable
+
+Component creates tables to view connected data while also applying default thematic styles and data colors.
+
+Signature:
+
+```typescript
+HierarchyBrowser: React.FC
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.header.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.header.md
new file mode 100644
index 00000000..adc0e0f7
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.header.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICardOverviewSettings](./hierarchy-browser.icardoverviewsettings.md) > [header](./hierarchy-browser.icardoverviewsettings.header.md)
+
+## ICardOverviewSettings.header property
+
+Signature:
+
+```typescript
+header?: React.CSSProperties;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.headertext.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.headertext.md
new file mode 100644
index 00000000..1ff34787
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.headertext.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICardOverviewSettings](./hierarchy-browser.icardoverviewsettings.md) > [headerText](./hierarchy-browser.icardoverviewsettings.headertext.md)
+
+## ICardOverviewSettings.headerText property
+
+Signature:
+
+```typescript
+headerText?: ITextProps['variant'];
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.iconbutton.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.iconbutton.md
new file mode 100644
index 00000000..3fe9581c
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.iconbutton.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICardOverviewSettings](./hierarchy-browser.icardoverviewsettings.md) > [iconButton](./hierarchy-browser.icardoverviewsettings.iconbutton.md)
+
+## ICardOverviewSettings.iconButton property
+
+Signature:
+
+```typescript
+iconButton?: IButtonStyles;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.md
new file mode 100644
index 00000000..b867953c
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICardOverviewSettings](./hierarchy-browser.icardoverviewsettings.md)
+
+## ICardOverviewSettings interface
+
+Signature:
+
+```typescript
+export interface ICardOverviewSettings
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [header?](./hierarchy-browser.icardoverviewsettings.header.md) | | React.CSSProperties | (Optional) |
+| [headerText?](./hierarchy-browser.icardoverviewsettings.headertext.md) | | ITextProps\['variant'\] | (Optional) |
+| [iconButton?](./hierarchy-browser.icardoverviewsettings.iconbutton.md) | | IButtonStyles | (Optional) |
+| [root?](./hierarchy-browser.icardoverviewsettings.root.md) | | React.CSSProperties | (Optional) |
+| [subheader?](./hierarchy-browser.icardoverviewsettings.subheader.md) | | React.CSSProperties | (Optional) |
+| [subHeaderText?](./hierarchy-browser.icardoverviewsettings.subheadertext.md) | | ITextProps\['variant'\] | (Optional) |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.root.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.root.md
new file mode 100644
index 00000000..346a5db0
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.root.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICardOverviewSettings](./hierarchy-browser.icardoverviewsettings.md) > [root](./hierarchy-browser.icardoverviewsettings.root.md)
+
+## ICardOverviewSettings.root property
+
+Signature:
+
+```typescript
+root?: React.CSSProperties;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.subheader.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.subheader.md
new file mode 100644
index 00000000..22a4c367
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.subheader.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICardOverviewSettings](./hierarchy-browser.icardoverviewsettings.md) > [subheader](./hierarchy-browser.icardoverviewsettings.subheader.md)
+
+## ICardOverviewSettings.subheader property
+
+Signature:
+
+```typescript
+subheader?: React.CSSProperties;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.subheadertext.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.subheadertext.md
new file mode 100644
index 00000000..f1450436
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icardoverviewsettings.subheadertext.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICardOverviewSettings](./hierarchy-browser.icardoverviewsettings.md) > [subHeaderText](./hierarchy-browser.icardoverviewsettings.subheadertext.md)
+
+## ICardOverviewSettings.subHeaderText property
+
+Signature:
+
+```typescript
+subHeaderText?: ITextProps['variant'];
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.communityid.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.communityid.md
new file mode 100644
index 00000000..7c53e945
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.communityid.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICommunityDetail](./hierarchy-browser.icommunitydetail.md) > [communityId](./hierarchy-browser.icommunitydetail.communityid.md)
+
+## ICommunityDetail.communityId property
+
+Signature:
+
+```typescript
+communityId: CommunityId;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.entityids.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.entityids.md
new file mode 100644
index 00000000..10912b17
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.entityids.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICommunityDetail](./hierarchy-browser.icommunitydetail.md) > [entityIds](./hierarchy-browser.icommunitydetail.entityids.md)
+
+## ICommunityDetail.entityIds property
+
+Signature:
+
+```typescript
+entityIds?: EntityId[];
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.md
new file mode 100644
index 00000000..ccf5f432
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICommunityDetail](./hierarchy-browser.icommunitydetail.md)
+
+## ICommunityDetail interface
+
+Signature:
+
+```typescript
+export interface ICommunityDetail
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [communityId](./hierarchy-browser.icommunitydetail.communityid.md) | | [CommunityId](./hierarchy-browser.communityid.md) | |
+| [entityIds?](./hierarchy-browser.icommunitydetail.entityids.md) | | [EntityId](./hierarchy-browser.entityid.md)\[\] | (Optional) |
+| [neighborSize?](./hierarchy-browser.icommunitydetail.neighborsize.md) | | number | (Optional) |
+| [size](./hierarchy-browser.icommunitydetail.size.md) | | number | |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.neighborsize.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.neighborsize.md
new file mode 100644
index 00000000..12e9aeeb
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.neighborsize.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICommunityDetail](./hierarchy-browser.icommunitydetail.md) > [neighborSize](./hierarchy-browser.icommunitydetail.neighborsize.md)
+
+## ICommunityDetail.neighborSize property
+
+Signature:
+
+```typescript
+neighborSize?: number;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.size.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.size.md
new file mode 100644
index 00000000..585c17bd
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icommunitydetail.size.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ICommunityDetail](./hierarchy-browser.icommunitydetail.md) > [size](./hierarchy-browser.icommunitydetail.size.md)
+
+## ICommunityDetail.size property
+
+Signature:
+
+```typescript
+size: number;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.md
new file mode 100644
index 00000000..0eff9b7c
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IControls](./hierarchy-browser.icontrols.md)
+
+## IControls interface
+
+Signature:
+
+```typescript
+export interface IControls
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [showExport?](./hierarchy-browser.icontrols.showexport.md) | | boolean | (Optional) |
+| [showFilter?](./hierarchy-browser.icontrols.showfilter.md) | | boolean | (Optional) |
+| [showLevel?](./hierarchy-browser.icontrols.showlevel.md) | | boolean | (Optional) |
+| [showMembership?](./hierarchy-browser.icontrols.showmembership.md) | | boolean | (Optional) |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showexport.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showexport.md
new file mode 100644
index 00000000..5b8215f7
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showexport.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IControls](./hierarchy-browser.icontrols.md) > [showExport](./hierarchy-browser.icontrols.showexport.md)
+
+## IControls.showExport property
+
+Signature:
+
+```typescript
+showExport?: boolean;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showfilter.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showfilter.md
new file mode 100644
index 00000000..cc2aea97
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showfilter.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IControls](./hierarchy-browser.icontrols.md) > [showFilter](./hierarchy-browser.icontrols.showfilter.md)
+
+## IControls.showFilter property
+
+Signature:
+
+```typescript
+showFilter?: boolean;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showlevel.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showlevel.md
new file mode 100644
index 00000000..0a16e014
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showlevel.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IControls](./hierarchy-browser.icontrols.md) > [showLevel](./hierarchy-browser.icontrols.showlevel.md)
+
+## IControls.showLevel property
+
+Signature:
+
+```typescript
+showLevel?: boolean;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showmembership.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showmembership.md
new file mode 100644
index 00000000..7e3f0f5a
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.icontrols.showmembership.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IControls](./hierarchy-browser.icontrols.md) > [showMembership](./hierarchy-browser.icontrols.showmembership.md)
+
+## IControls.showMembership property
+
+Signature:
+
+```typescript
+showMembership?: boolean;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ientitydetail.attrs.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ientitydetail.attrs.md
new file mode 100644
index 00000000..5f9449ec
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ientitydetail.attrs.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IEntityDetail](./hierarchy-browser.ientitydetail.md) > [attrs](./hierarchy-browser.ientitydetail.attrs.md)
+
+## IEntityDetail.attrs property
+
+Signature:
+
+```typescript
+attrs?: {
+ [key: string]: string | number;
+ };
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ientitydetail.id.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ientitydetail.id.md
new file mode 100644
index 00000000..e727cbdb
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ientitydetail.id.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IEntityDetail](./hierarchy-browser.ientitydetail.md) > [id](./hierarchy-browser.ientitydetail.id.md)
+
+## IEntityDetail.id property
+
+Signature:
+
+```typescript
+id: EntityId;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ientitydetail.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ientitydetail.md
new file mode 100644
index 00000000..46d6c278
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ientitydetail.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IEntityDetail](./hierarchy-browser.ientitydetail.md)
+
+## IEntityDetail interface
+
+Signature:
+
+```typescript
+export interface IEntityDetail
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [attrs?](./hierarchy-browser.ientitydetail.attrs.md) | | { \[key: string\]: string \| number; } | (Optional) |
+| [id](./hierarchy-browser.ientitydetail.id.md) | | [EntityId](./hierarchy-browser.entityid.md) | |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataprovider.getcommunitydata.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataprovider.getcommunitydata.md
new file mode 100644
index 00000000..38fff32e
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataprovider.getcommunitydata.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IHierarchyDataProvider](./hierarchy-browser.ihierarchydataprovider.md) > [getCommunityData](./hierarchy-browser.ihierarchydataprovider.getcommunitydata.md)
+
+## IHierarchyDataProvider.getCommunityData property
+
+Signature:
+
+```typescript
+getCommunityData: () => ICommunityDetail[];
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataprovider.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataprovider.md
new file mode 100644
index 00000000..f82bd07c
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataprovider.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IHierarchyDataProvider](./hierarchy-browser.ihierarchydataprovider.md)
+
+## IHierarchyDataProvider interface
+
+Signature:
+
+```typescript
+export interface IHierarchyDataProvider
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [getCommunityData](./hierarchy-browser.ihierarchydataprovider.getcommunitydata.md) | | () => [ICommunityDetail](./hierarchy-browser.icommunitydetail.md)\[\] | |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataresponse.data.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataresponse.data.md
new file mode 100644
index 00000000..1dc5d70d
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataresponse.data.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IHierarchyDataResponse](./hierarchy-browser.ihierarchydataresponse.md) > [data](./hierarchy-browser.ihierarchydataresponse.data.md)
+
+## IHierarchyDataResponse.data property
+
+Signature:
+
+```typescript
+data?: IEntityDetail[];
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataresponse.error.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataresponse.error.md
new file mode 100644
index 00000000..8bb9a769
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataresponse.error.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IHierarchyDataResponse](./hierarchy-browser.ihierarchydataresponse.md) > [error](./hierarchy-browser.ihierarchydataresponse.error.md)
+
+## IHierarchyDataResponse.error property
+
+Signature:
+
+```typescript
+error?: Error | null;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataresponse.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataresponse.md
new file mode 100644
index 00000000..100fce74
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchydataresponse.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IHierarchyDataResponse](./hierarchy-browser.ihierarchydataresponse.md)
+
+## IHierarchyDataResponse interface
+
+Signature:
+
+```typescript
+export interface IHierarchyDataResponse
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [data?](./hierarchy-browser.ihierarchydataresponse.data.md) | | [IEntityDetail](./hierarchy-browser.ientitydetail.md)\[\] | (Optional) |
+| [error?](./hierarchy-browser.ihierarchydataresponse.error.md) | | Error \| null | (Optional) |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchyneighborresponse.data.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchyneighborresponse.data.md
new file mode 100644
index 00000000..8f6c625f
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchyneighborresponse.data.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IHierarchyNeighborResponse](./hierarchy-browser.ihierarchyneighborresponse.md) > [data](./hierarchy-browser.ihierarchyneighborresponse.data.md)
+
+## IHierarchyNeighborResponse.data property
+
+Signature:
+
+```typescript
+data?: INeighborCommunityDetail[];
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchyneighborresponse.error.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchyneighborresponse.error.md
new file mode 100644
index 00000000..d56f4e19
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchyneighborresponse.error.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IHierarchyNeighborResponse](./hierarchy-browser.ihierarchyneighborresponse.md) > [error](./hierarchy-browser.ihierarchyneighborresponse.error.md)
+
+## IHierarchyNeighborResponse.error property
+
+Signature:
+
+```typescript
+error?: Error | null | undefined;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchyneighborresponse.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchyneighborresponse.md
new file mode 100644
index 00000000..e3254c9b
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ihierarchyneighborresponse.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IHierarchyNeighborResponse](./hierarchy-browser.ihierarchyneighborresponse.md)
+
+## IHierarchyNeighborResponse interface
+
+Signature:
+
+```typescript
+export interface IHierarchyNeighborResponse
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [data?](./hierarchy-browser.ihierarchyneighborresponse.data.md) | | [INeighborCommunityDetail](./hierarchy-browser.ineighborcommunitydetail.md)\[\] | (Optional) |
+| [error?](./hierarchy-browser.ihierarchyneighborresponse.error.md) | | Error \| null \| undefined | (Optional) |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadentitiesasync.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadentitiesasync.md
new file mode 100644
index 00000000..10cbc1f4
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadentitiesasync.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ILoadEntitiesAsync](./hierarchy-browser.iloadentitiesasync.md)
+
+## ILoadEntitiesAsync interface
+
+Signature:
+
+```typescript
+export interface ILoadEntitiesAsync
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadneighborcommunities.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadneighborcommunities.md
new file mode 100644
index 00000000..b734b46f
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadneighborcommunities.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ILoadNeighborCommunities](./hierarchy-browser.iloadneighborcommunities.md)
+
+## ILoadNeighborCommunities interface
+
+Signature:
+
+```typescript
+export interface ILoadNeighborCommunities
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadneighborcommunitiesasync.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadneighborcommunitiesasync.md
new file mode 100644
index 00000000..2434c192
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadneighborcommunitiesasync.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ILoadNeighborCommunitiesAsync](./hierarchy-browser.iloadneighborcommunitiesasync.md)
+
+## ILoadNeighborCommunitiesAsync interface
+
+Signature:
+
+```typescript
+export interface ILoadNeighborCommunitiesAsync
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.communityid.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.communityid.md
new file mode 100644
index 00000000..89452adf
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.communityid.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ILoadParams](./hierarchy-browser.iloadparams.md) > [communityId](./hierarchy-browser.iloadparams.communityid.md)
+
+## ILoadParams.communityId property
+
+Signature:
+
+```typescript
+communityId: CommunityId;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.count.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.count.md
new file mode 100644
index 00000000..169ca758
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.count.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ILoadParams](./hierarchy-browser.iloadparams.md) > [count](./hierarchy-browser.iloadparams.count.md)
+
+## ILoadParams.count property
+
+Signature:
+
+```typescript
+count: number;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.filtered.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.filtered.md
new file mode 100644
index 00000000..a272f080
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.filtered.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ILoadParams](./hierarchy-browser.iloadparams.md) > [filtered](./hierarchy-browser.iloadparams.filtered.md)
+
+## ILoadParams.filtered property
+
+Signature:
+
+```typescript
+filtered: boolean;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.level.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.level.md
new file mode 100644
index 00000000..e588c713
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.level.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ILoadParams](./hierarchy-browser.iloadparams.md) > [level](./hierarchy-browser.iloadparams.level.md)
+
+## ILoadParams.level property
+
+Signature:
+
+```typescript
+level: number;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.md
new file mode 100644
index 00000000..85bf8066
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ILoadParams](./hierarchy-browser.iloadparams.md)
+
+## ILoadParams interface
+
+Signature:
+
+```typescript
+export interface ILoadParams
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [communityId](./hierarchy-browser.iloadparams.communityid.md) | | [CommunityId](./hierarchy-browser.communityid.md) | |
+| [count](./hierarchy-browser.iloadparams.count.md) | | number | |
+| [filtered](./hierarchy-browser.iloadparams.filtered.md) | | boolean | |
+| [level](./hierarchy-browser.iloadparams.level.md) | | number | |
+| [offset](./hierarchy-browser.iloadparams.offset.md) | | number | |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.offset.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.offset.md
new file mode 100644
index 00000000..f6b5f027
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.iloadparams.offset.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ILoadParams](./hierarchy-browser.iloadparams.md) > [offset](./hierarchy-browser.iloadparams.offset.md)
+
+## ILoadParams.offset property
+
+Signature:
+
+```typescript
+offset: number;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ineighborcommunitydetail.connections.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ineighborcommunitydetail.connections.md
new file mode 100644
index 00000000..b6af254c
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ineighborcommunitydetail.connections.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [INeighborCommunityDetail](./hierarchy-browser.ineighborcommunitydetail.md) > [connections](./hierarchy-browser.ineighborcommunitydetail.connections.md)
+
+## INeighborCommunityDetail.connections property
+
+Signature:
+
+```typescript
+connections: number;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ineighborcommunitydetail.edgecommunityid.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ineighborcommunitydetail.edgecommunityid.md
new file mode 100644
index 00000000..2ff501f0
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ineighborcommunitydetail.edgecommunityid.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [INeighborCommunityDetail](./hierarchy-browser.ineighborcommunitydetail.md) > [edgeCommunityId](./hierarchy-browser.ineighborcommunitydetail.edgecommunityid.md)
+
+## INeighborCommunityDetail.edgeCommunityId property
+
+Signature:
+
+```typescript
+edgeCommunityId: CommunityId;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ineighborcommunitydetail.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ineighborcommunitydetail.md
new file mode 100644
index 00000000..a03dd16b
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ineighborcommunitydetail.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [INeighborCommunityDetail](./hierarchy-browser.ineighborcommunitydetail.md)
+
+## INeighborCommunityDetail interface
+
+Signature:
+
+```typescript
+export interface INeighborCommunityDetail extends ICommunityDetail
+```
+Extends: [ICommunityDetail](./hierarchy-browser.icommunitydetail.md)
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [connections](./hierarchy-browser.ineighborcommunitydetail.connections.md) | | number | |
+| [edgeCommunityId](./hierarchy-browser.ineighborcommunitydetail.edgecommunityid.md) | | [CommunityId](./hierarchy-browser.communityid.md) | |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ionselectionchange.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ionselectionchange.md
new file mode 100644
index 00000000..74a33820
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.ionselectionchange.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IOnSelectionChange](./hierarchy-browser.ionselectionchange.md)
+
+## IOnSelectionChange interface
+
+Signature:
+
+```typescript
+export interface IOnSelectionChange
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.controls.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.controls.md
new file mode 100644
index 00000000..64e0ca29
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.controls.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ISettings](./hierarchy-browser.isettings.md) > [controls](./hierarchy-browser.isettings.controls.md)
+
+## ISettings.controls property
+
+Signature:
+
+```typescript
+controls?: IControls;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.isopen.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.isopen.md
new file mode 100644
index 00000000..92952317
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.isopen.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ISettings](./hierarchy-browser.isettings.md) > [isOpen](./hierarchy-browser.isettings.isopen.md)
+
+## ISettings.isOpen property
+
+Signature:
+
+```typescript
+isOpen?: boolean;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.md
new file mode 100644
index 00000000..27280666
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ISettings](./hierarchy-browser.isettings.md)
+
+## ISettings interface
+
+Signature:
+
+```typescript
+export interface ISettings
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [controls?](./hierarchy-browser.isettings.controls.md) | | [IControls](./hierarchy-browser.icontrols.md) | (Optional) |
+| [isOpen?](./hierarchy-browser.isettings.isopen.md) | | boolean | (Optional) |
+| [minimizeColumns?](./hierarchy-browser.isettings.minimizecolumns.md) | | boolean | (Optional) |
+| [styles?](./hierarchy-browser.isettings.styles.md) | | [IStyles](./hierarchy-browser.istyles.md) | (Optional) |
+| [visibleColumns?](./hierarchy-browser.isettings.visiblecolumns.md) | | string\[\] | (Optional) |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.minimizecolumns.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.minimizecolumns.md
new file mode 100644
index 00000000..3e7b46a0
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.minimizecolumns.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ISettings](./hierarchy-browser.isettings.md) > [minimizeColumns](./hierarchy-browser.isettings.minimizecolumns.md)
+
+## ISettings.minimizeColumns property
+
+Signature:
+
+```typescript
+minimizeColumns?: boolean;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.styles.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.styles.md
new file mode 100644
index 00000000..ed911b83
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.styles.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ISettings](./hierarchy-browser.isettings.md) > [styles](./hierarchy-browser.isettings.styles.md)
+
+## ISettings.styles property
+
+Signature:
+
+```typescript
+styles?: IStyles;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.visiblecolumns.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.visiblecolumns.md
new file mode 100644
index 00000000..583a7f25
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.isettings.visiblecolumns.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ISettings](./hierarchy-browser.isettings.md) > [visibleColumns](./hierarchy-browser.isettings.visiblecolumns.md)
+
+## ISettings.visibleColumns property
+
+Signature:
+
+```typescript
+visibleColumns?: string[];
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.istyles.cardoverview.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.istyles.cardoverview.md
new file mode 100644
index 00000000..e6fe7892
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.istyles.cardoverview.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IStyles](./hierarchy-browser.istyles.md) > [cardOverview](./hierarchy-browser.istyles.cardoverview.md)
+
+## IStyles.cardOverview property
+
+Signature:
+
+```typescript
+cardOverview?: ICardOverviewSettings;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.istyles.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.istyles.md
new file mode 100644
index 00000000..bd1cd777
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.istyles.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IStyles](./hierarchy-browser.istyles.md)
+
+## IStyles interface
+
+Signature:
+
+```typescript
+export interface IStyles
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [cardOverview?](./hierarchy-browser.istyles.cardoverview.md) | | [ICardOverviewSettings](./hierarchy-browser.icardoverviewsettings.md) | (Optional) |
+| [table?](./hierarchy-browser.istyles.table.md) | | [ITableSettings](./hierarchy-browser.itablesettings.md) | (Optional) |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.istyles.table.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.istyles.table.md
new file mode 100644
index 00000000..8a6e108e
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.istyles.table.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [IStyles](./hierarchy-browser.istyles.md) > [table](./hierarchy-browser.istyles.table.md)
+
+## IStyles.table property
+
+Signature:
+
+```typescript
+table?: ITableSettings;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.header.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.header.md
new file mode 100644
index 00000000..4a22915d
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.header.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ITableSettings](./hierarchy-browser.itablesettings.md) > [header](./hierarchy-browser.itablesettings.header.md)
+
+## ITableSettings.header property
+
+Signature:
+
+```typescript
+header?: React.CSSProperties;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.headertext.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.headertext.md
new file mode 100644
index 00000000..6b7674ae
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.headertext.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ITableSettings](./hierarchy-browser.itablesettings.md) > [headerText](./hierarchy-browser.itablesettings.headertext.md)
+
+## ITableSettings.headerText property
+
+Signature:
+
+```typescript
+headerText?: ITextProps['variant'];
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.md
new file mode 100644
index 00000000..71dd1ff3
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.md
@@ -0,0 +1,25 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ITableSettings](./hierarchy-browser.itablesettings.md)
+
+## ITableSettings interface
+
+Signature:
+
+```typescript
+export interface ITableSettings
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [header?](./hierarchy-browser.itablesettings.header.md) | | React.CSSProperties | (Optional) |
+| [headerText?](./hierarchy-browser.itablesettings.headertext.md) | | ITextProps\['variant'\] | (Optional) |
+| [neighborExpandButton?](./hierarchy-browser.itablesettings.neighborexpandbutton.md) | | IButtonStyles | (Optional) |
+| [root?](./hierarchy-browser.itablesettings.root.md) | | React.CSSProperties | (Optional) |
+| [subheader?](./hierarchy-browser.itablesettings.subheader.md) | | React.CSSProperties | (Optional) |
+| [subHeaderText?](./hierarchy-browser.itablesettings.subheadertext.md) | | ITextProps\['variant'\] | (Optional) |
+| [tableItems?](./hierarchy-browser.itablesettings.tableitems.md) | | React.CSSProperties | (Optional) |
+| [tableItemsText?](./hierarchy-browser.itablesettings.tableitemstext.md) | | ITextProps\['variant'\] | (Optional) |
+
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.neighborexpandbutton.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.neighborexpandbutton.md
new file mode 100644
index 00000000..263a8661
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.neighborexpandbutton.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ITableSettings](./hierarchy-browser.itablesettings.md) > [neighborExpandButton](./hierarchy-browser.itablesettings.neighborexpandbutton.md)
+
+## ITableSettings.neighborExpandButton property
+
+Signature:
+
+```typescript
+neighborExpandButton?: IButtonStyles;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.root.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.root.md
new file mode 100644
index 00000000..c910e985
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.root.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ITableSettings](./hierarchy-browser.itablesettings.md) > [root](./hierarchy-browser.itablesettings.root.md)
+
+## ITableSettings.root property
+
+Signature:
+
+```typescript
+root?: React.CSSProperties;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.subheader.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.subheader.md
new file mode 100644
index 00000000..8ba137ce
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.subheader.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ITableSettings](./hierarchy-browser.itablesettings.md) > [subheader](./hierarchy-browser.itablesettings.subheader.md)
+
+## ITableSettings.subheader property
+
+Signature:
+
+```typescript
+subheader?: React.CSSProperties;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.subheadertext.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.subheadertext.md
new file mode 100644
index 00000000..64b032ab
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.subheadertext.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ITableSettings](./hierarchy-browser.itablesettings.md) > [subHeaderText](./hierarchy-browser.itablesettings.subheadertext.md)
+
+## ITableSettings.subHeaderText property
+
+Signature:
+
+```typescript
+subHeaderText?: ITextProps['variant'];
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.tableitems.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.tableitems.md
new file mode 100644
index 00000000..2a0f8f3a
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.tableitems.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ITableSettings](./hierarchy-browser.itablesettings.md) > [tableItems](./hierarchy-browser.itablesettings.tableitems.md)
+
+## ITableSettings.tableItems property
+
+Signature:
+
+```typescript
+tableItems?: React.CSSProperties;
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.tableitemstext.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.tableitemstext.md
new file mode 100644
index 00000000..ed3b7f06
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.itablesettings.tableitemstext.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md) > [ITableSettings](./hierarchy-browser.itablesettings.md) > [tableItemsText](./hierarchy-browser.itablesettings.tableitemstext.md)
+
+## ITableSettings.tableItemsText property
+
+Signature:
+
+```typescript
+tableItemsText?: ITextProps['variant'];
+```
diff --git a/packages/hierarchy-browser/docs/markdown/hierarchy-browser.md b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.md
new file mode 100644
index 00000000..1284eec0
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/hierarchy-browser.md
@@ -0,0 +1,40 @@
+
+
+[Home](./index.md) > [@essex/hierarchy-browser](./hierarchy-browser.md)
+
+## hierarchy-browser package
+
+## Interfaces
+
+| Interface | Description |
+| --- | --- |
+| [ICardOverviewSettings](./hierarchy-browser.icardoverviewsettings.md) | |
+| [ICommunityDetail](./hierarchy-browser.icommunitydetail.md) | |
+| [IControls](./hierarchy-browser.icontrols.md) | |
+| [IEntityDetail](./hierarchy-browser.ientitydetail.md) | |
+| [IHierarchyDataProvider](./hierarchy-browser.ihierarchydataprovider.md) | |
+| [IHierarchyDataResponse](./hierarchy-browser.ihierarchydataresponse.md) | |
+| [IHierarchyNeighborResponse](./hierarchy-browser.ihierarchyneighborresponse.md) | |
+| [ILoadEntitiesAsync](./hierarchy-browser.iloadentitiesasync.md) | |
+| [ILoadNeighborCommunities](./hierarchy-browser.iloadneighborcommunities.md) | |
+| [ILoadNeighborCommunitiesAsync](./hierarchy-browser.iloadneighborcommunitiesasync.md) | |
+| [ILoadParams](./hierarchy-browser.iloadparams.md) | |
+| [INeighborCommunityDetail](./hierarchy-browser.ineighborcommunitydetail.md) | |
+| [IOnSelectionChange](./hierarchy-browser.ionselectionchange.md) | |
+| [ISettings](./hierarchy-browser.isettings.md) | |
+| [IStyles](./hierarchy-browser.istyles.md) | |
+| [ITableSettings](./hierarchy-browser.itablesettings.md) | |
+
+## Variables
+
+| Variable | Description |
+| --- | --- |
+| [HierarchyBrowser](./hierarchy-browser.hierarchybrowser.md) | Component creates tables to view connected data while also applying default thematic styles and data colors. |
+
+## Type Aliases
+
+| Type Alias | Description |
+| --- | --- |
+| [CommunityId](./hierarchy-browser.communityid.md) | |
+| [EntityId](./hierarchy-browser.entityid.md) | |
+
diff --git a/packages/hierarchy-browser/docs/markdown/index.md b/packages/hierarchy-browser/docs/markdown/index.md
new file mode 100644
index 00000000..ea34c865
--- /dev/null
+++ b/packages/hierarchy-browser/docs/markdown/index.md
@@ -0,0 +1,12 @@
+
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+| Package | Description |
+| --- | --- |
+| [@essex/hierarchy-browser](./hierarchy-browser.md) | |
+
diff --git a/packages/hierarchy-browser/docs/report/hierarchy-browser.api.json b/packages/hierarchy-browser/docs/report/hierarchy-browser.api.json
new file mode 100644
index 00000000..c39e312a
--- /dev/null
+++ b/packages/hierarchy-browser/docs/report/hierarchy-browser.api.json
@@ -0,0 +1,2026 @@
+{
+ "metadata": {
+ "toolPackage": "@microsoft/api-extractor",
+ "toolVersion": "7.29.2",
+ "schemaVersion": 1009,
+ "oldestForwardsCompatibleVersion": 1001,
+ "tsdocConfig": {
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+ "noStandardTags": true,
+ "tagDefinitions": [
+ {
+ "tagName": "@alpha",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@beta",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@defaultValue",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@decorator",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@deprecated",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@eventProperty",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@example",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@experimental",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@inheritDoc",
+ "syntaxKind": "inline"
+ },
+ {
+ "tagName": "@internal",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@label",
+ "syntaxKind": "inline"
+ },
+ {
+ "tagName": "@link",
+ "syntaxKind": "inline",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@override",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@packageDocumentation",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@param",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@privateRemarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@public",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@readonly",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@remarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@returns",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@sealed",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@see",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@throws",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@typeParam",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@virtual",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@betaDocumentation",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@internalRemarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@preapproved",
+ "syntaxKind": "modifier"
+ }
+ ],
+ "supportForTags": {
+ "@alpha": true,
+ "@beta": true,
+ "@defaultValue": true,
+ "@decorator": true,
+ "@deprecated": true,
+ "@eventProperty": true,
+ "@example": true,
+ "@experimental": true,
+ "@inheritDoc": true,
+ "@internal": true,
+ "@label": true,
+ "@link": true,
+ "@override": true,
+ "@packageDocumentation": true,
+ "@param": true,
+ "@privateRemarks": true,
+ "@public": true,
+ "@readonly": true,
+ "@remarks": true,
+ "@returns": true,
+ "@sealed": true,
+ "@see": true,
+ "@throws": true,
+ "@typeParam": true,
+ "@virtual": true,
+ "@betaDocumentation": true,
+ "@internalRemarks": true,
+ "@preapproved": true
+ },
+ "reportUnsupportedHtmlElements": false
+ }
+ },
+ "kind": "Package",
+ "canonicalReference": "@essex/hierarchy-browser!",
+ "docComment": "",
+ "name": "@essex/hierarchy-browser",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "EntryPoint",
+ "canonicalReference": "@essex/hierarchy-browser!",
+ "name": "",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "TypeAlias",
+ "canonicalReference": "@essex/hierarchy-browser!CommunityId:type",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export type CommunityId = "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "CommunityId",
+ "typeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "TypeAlias",
+ "canonicalReference": "@essex/hierarchy-browser!EntityId:type",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export type EntityId = "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "EntityId",
+ "typeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/hierarchy-browser!HierarchyBrowser:var",
+ "docComment": "/**\n * Component creates tables to view connected data while also applying default thematic styles and data colors.\n *\n * @param communities - required ICommunityDetail[]\n *\n * @param entities - (optional) IEntityDetail[] | ILoadEntitiesAsync\n *\n * @param neighbors - (optional) INeighborCommunityDetail[] | ILoadNeighborCommunitiesAsync\n *\n * @param settings - (optional) ISettings\n *\n * @param selections - (optional) EntityId[]\n *\n * @param onSelectionChange - (optional) IOnSelectionChange\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "HierarchyBrowser: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.FC",
+ "canonicalReference": "@types/react!~React.FC:type"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IHierarchyBrowserProps",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyBrowserProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "HierarchyBrowser",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ }
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!ICardOverviewSettings:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ICardOverviewSettings "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ICardOverviewSettings",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ICardOverviewSettings#header:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "header?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "header",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ICardOverviewSettings#headerText:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "headerText?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ITextProps",
+ "canonicalReference": "@fluentui/react!ITextProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "['variant']"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "headerText",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ICardOverviewSettings#iconButton:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "iconButton?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IButtonStyles",
+ "canonicalReference": "@fluentui/react!IButtonStyles:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "iconButton",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ICardOverviewSettings#root:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "root?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "root",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ICardOverviewSettings#subheader:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "subheader?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "subheader",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ICardOverviewSettings#subHeaderText:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "subHeaderText?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ITextProps",
+ "canonicalReference": "@fluentui/react!ITextProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "['variant']"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "subHeaderText",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!ICommunityDetail:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ICommunityDetail "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ICommunityDetail",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ICommunityDetail#communityId:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "communityId: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CommunityId",
+ "canonicalReference": "@essex/hierarchy-browser!CommunityId:type"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "communityId",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ICommunityDetail#entityIds:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "entityIds?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "EntityId",
+ "canonicalReference": "@essex/hierarchy-browser!EntityId:type"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "entityIds",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ICommunityDetail#neighborSize:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "neighborSize?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "neighborSize",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ICommunityDetail#size:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "size: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "size",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!IControls:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IControls "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "IControls",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IControls#showExport:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "showExport?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "showExport",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IControls#showFilter:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "showFilter?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "showFilter",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IControls#showLevel:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "showLevel?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "showLevel",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IControls#showMembership:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "showMembership?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "showMembership",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!IEntityDetail:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IEntityDetail "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "IEntityDetail",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IEntityDetail#attrs:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "attrs?: "
+ },
+ {
+ "kind": "Content",
+ "text": "{\n [key: string]: string | number;\n }"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "attrs",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IEntityDetail#id:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "id: "
+ },
+ {
+ "kind": "Reference",
+ "text": "EntityId",
+ "canonicalReference": "@essex/hierarchy-browser!EntityId:type"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "id",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyDataProvider:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IHierarchyDataProvider "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "IHierarchyDataProvider",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyDataProvider#getCommunityData:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "getCommunityData: "
+ },
+ {
+ "kind": "Content",
+ "text": "() => "
+ },
+ {
+ "kind": "Reference",
+ "text": "ICommunityDetail",
+ "canonicalReference": "@essex/hierarchy-browser!ICommunityDetail:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "getCommunityData",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 4
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyDataResponse:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IHierarchyDataResponse "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "IHierarchyDataResponse",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyDataResponse#data:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "data?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IEntityDetail",
+ "canonicalReference": "@essex/hierarchy-browser!IEntityDetail:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "data",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyDataResponse#error:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "error?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Error",
+ "canonicalReference": "!Error:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | null"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "error",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyNeighborResponse:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IHierarchyNeighborResponse "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "IHierarchyNeighborResponse",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyNeighborResponse#data:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "data?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "INeighborCommunityDetail",
+ "canonicalReference": "@essex/hierarchy-browser!INeighborCommunityDetail:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "data",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyNeighborResponse#error:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "error?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Error",
+ "canonicalReference": "!Error:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | null | undefined"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "error",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadEntitiesAsync:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ILoadEntitiesAsync "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ILoadEntitiesAsync",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "CallSignature",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadEntitiesAsync:call(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "(params: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ILoadParams",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadParams:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IHierarchyDataResponse",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyDataResponse:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 7
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "params",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ }
+ ]
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadNeighborCommunities:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ILoadNeighborCommunities "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ILoadNeighborCommunities",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "CallSignature",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadNeighborCommunities:call(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "(params: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ILoadParams",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadParams:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ", communityId: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CommunityId",
+ "canonicalReference": "@essex/hierarchy-browser!CommunityId:type"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IHierarchyNeighborResponse",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyNeighborResponse:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 5,
+ "endIndex": 9
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "params",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "communityId",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "isOptional": false
+ }
+ ]
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadNeighborCommunitiesAsync:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ILoadNeighborCommunitiesAsync "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ILoadNeighborCommunitiesAsync",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "CallSignature",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadNeighborCommunitiesAsync:call(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "(params: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ILoadParams",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadParams:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "IHierarchyNeighborResponse",
+ "canonicalReference": "@essex/hierarchy-browser!IHierarchyNeighborResponse:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ">"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 7
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "params",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ }
+ ]
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadParams:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ILoadParams "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ILoadParams",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadParams#communityId:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "communityId: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CommunityId",
+ "canonicalReference": "@essex/hierarchy-browser!CommunityId:type"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "communityId",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadParams#count:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "count: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "count",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadParams#filtered:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "filtered: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "filtered",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadParams#level:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "level: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "level",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ILoadParams#offset:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "offset: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "offset",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!INeighborCommunityDetail:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface INeighborCommunityDetail extends "
+ },
+ {
+ "kind": "Reference",
+ "text": "ICommunityDetail",
+ "canonicalReference": "@essex/hierarchy-browser!ICommunityDetail:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "INeighborCommunityDetail",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!INeighborCommunityDetail#connections:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "connections: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "connections",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!INeighborCommunityDetail#edgeCommunityId:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "edgeCommunityId: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CommunityId",
+ "canonicalReference": "@essex/hierarchy-browser!CommunityId:type"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "edgeCommunityId",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": [
+ {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ ]
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!IOnSelectionChange:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IOnSelectionChange "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "IOnSelectionChange",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "CallSignature",
+ "canonicalReference": "@essex/hierarchy-browser!IOnSelectionChange:call(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "(communityIds: "
+ },
+ {
+ "kind": "Reference",
+ "text": "CommunityId",
+ "canonicalReference": "@essex/hierarchy-browser!CommunityId:type"
+ },
+ {
+ "kind": "Content",
+ "text": "[]"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 4,
+ "endIndex": 5
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "communityIds",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ },
+ "isOptional": false
+ }
+ ]
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!ISettings:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ISettings "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ISettings",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ISettings#controls:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "controls?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IControls",
+ "canonicalReference": "@essex/hierarchy-browser!IControls:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "controls",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ISettings#isOpen:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "isOpen?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "isOpen",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ISettings#minimizeColumns:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "minimizeColumns?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "minimizeColumns",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ISettings#styles:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "styles?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IStyles",
+ "canonicalReference": "@essex/hierarchy-browser!IStyles:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "styles",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ISettings#visibleColumns:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "visibleColumns?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string[]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "visibleColumns",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!IStyles:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface IStyles "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "IStyles",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IStyles#cardOverview:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "cardOverview?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ICardOverviewSettings",
+ "canonicalReference": "@essex/hierarchy-browser!ICardOverviewSettings:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "cardOverview",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!IStyles#table:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "table?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ITableSettings",
+ "canonicalReference": "@essex/hierarchy-browser!ITableSettings:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "table",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hierarchy-browser!ITableSettings:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ITableSettings "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ITableSettings",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ITableSettings#header:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "header?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "header",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ITableSettings#headerText:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "headerText?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ITextProps",
+ "canonicalReference": "@fluentui/react!ITextProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "['variant']"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "headerText",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ITableSettings#neighborExpandButton:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "neighborExpandButton?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IButtonStyles",
+ "canonicalReference": "@fluentui/react!IButtonStyles:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "neighborExpandButton",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ITableSettings#root:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "root?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "root",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ITableSettings#subheader:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "subheader?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "subheader",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ITableSettings#subHeaderText:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "subHeaderText?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ITextProps",
+ "canonicalReference": "@fluentui/react!ITextProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "['variant']"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "subHeaderText",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ITableSettings#tableItems:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "tableItems?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "React.CSSProperties",
+ "canonicalReference": "@types/react!~React.CSSProperties:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "tableItems",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hierarchy-browser!ITableSettings#tableItemsText:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "tableItemsText?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ITextProps",
+ "canonicalReference": "@fluentui/react!ITextProps:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "['variant']"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "tableItemsText",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 3
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ }
+ ]
+ }
+ ]
+}
diff --git a/packages/hierarchy-browser/docs/report/hierarchy-browser.api.md b/packages/hierarchy-browser/docs/report/hierarchy-browser.api.md
new file mode 100644
index 00000000..d9121b87
--- /dev/null
+++ b/packages/hierarchy-browser/docs/report/hierarchy-browser.api.md
@@ -0,0 +1,222 @@
+## API Report File for "@essex/hierarchy-browser"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+///
+
+import type { IButtonStyles } from '@fluentui/react';
+import type { ITextProps } from '@fluentui/react';
+
+// Warning: (ae-missing-release-tag) "CommunityId" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type CommunityId = string;
+
+// Warning: (ae-missing-release-tag) "EntityId" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type EntityId = string;
+
+// Warning: (ae-forgotten-export) The symbol "IHierarchyBrowserProps" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "HierarchyBrowser" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const HierarchyBrowser: React.FC;
+
+// Warning: (ae-missing-release-tag) "ICardOverviewSettings" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ICardOverviewSettings {
+ // (undocumented)
+ header?: React.CSSProperties;
+ // (undocumented)
+ headerText?: ITextProps['variant'];
+ // (undocumented)
+ iconButton?: IButtonStyles;
+ // (undocumented)
+ root?: React.CSSProperties;
+ // (undocumented)
+ subheader?: React.CSSProperties;
+ // (undocumented)
+ subHeaderText?: ITextProps['variant'];
+}
+
+// Warning: (ae-missing-release-tag) "ICommunityDetail" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ICommunityDetail {
+ // (undocumented)
+ communityId: CommunityId;
+ // (undocumented)
+ entityIds?: EntityId[];
+ // (undocumented)
+ neighborSize?: number;
+ // (undocumented)
+ size: number;
+}
+
+// Warning: (ae-missing-release-tag) "IControls" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IControls {
+ // (undocumented)
+ showExport?: boolean;
+ // (undocumented)
+ showFilter?: boolean;
+ // (undocumented)
+ showLevel?: boolean;
+ // (undocumented)
+ showMembership?: boolean;
+}
+
+// Warning: (ae-missing-release-tag) "IEntityDetail" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IEntityDetail {
+ // (undocumented)
+ attrs?: {
+ [key: string]: string | number;
+ };
+ // (undocumented)
+ id: EntityId;
+}
+
+// Warning: (ae-missing-release-tag) "IHierarchyDataProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IHierarchyDataProvider {
+ // (undocumented)
+ getCommunityData: () => ICommunityDetail[];
+}
+
+// Warning: (ae-missing-release-tag) "IHierarchyDataResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IHierarchyDataResponse {
+ // (undocumented)
+ data?: IEntityDetail[];
+ // (undocumented)
+ error?: Error | null;
+}
+
+// Warning: (ae-missing-release-tag) "IHierarchyNeighborResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IHierarchyNeighborResponse {
+ // (undocumented)
+ data?: INeighborCommunityDetail[];
+ // (undocumented)
+ error?: Error | null | undefined;
+}
+
+// Warning: (ae-missing-release-tag) "ILoadEntitiesAsync" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ILoadEntitiesAsync {
+ // (undocumented)
+ (params: ILoadParams): Promise;
+}
+
+// Warning: (ae-missing-release-tag) "ILoadNeighborCommunities" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ILoadNeighborCommunities {
+ // (undocumented)
+ (params: ILoadParams, communityId: CommunityId): Promise;
+}
+
+// Warning: (ae-missing-release-tag) "ILoadNeighborCommunitiesAsync" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ILoadNeighborCommunitiesAsync {
+ // (undocumented)
+ (params: ILoadParams): Promise;
+}
+
+// Warning: (ae-missing-release-tag) "ILoadParams" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ILoadParams {
+ // (undocumented)
+ communityId: CommunityId;
+ // (undocumented)
+ count: number;
+ // (undocumented)
+ filtered: boolean;
+ // (undocumented)
+ level: number;
+ // (undocumented)
+ offset: number;
+}
+
+// Warning: (ae-missing-release-tag) "INeighborCommunityDetail" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface INeighborCommunityDetail extends ICommunityDetail {
+ // (undocumented)
+ connections: number;
+ // (undocumented)
+ edgeCommunityId: CommunityId;
+}
+
+// Warning: (ae-missing-release-tag) "IOnSelectionChange" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IOnSelectionChange {
+ // (undocumented)
+ (communityIds: CommunityId[]): void;
+}
+
+// Warning: (ae-missing-release-tag) "ISettings" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ISettings {
+ // (undocumented)
+ controls?: IControls;
+ // (undocumented)
+ isOpen?: boolean;
+ // (undocumented)
+ minimizeColumns?: boolean;
+ // (undocumented)
+ styles?: IStyles;
+ // (undocumented)
+ visibleColumns?: string[];
+}
+
+// Warning: (ae-missing-release-tag) "IStyles" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface IStyles {
+ // (undocumented)
+ cardOverview?: ICardOverviewSettings;
+ // (undocumented)
+ table?: ITableSettings;
+}
+
+// Warning: (ae-missing-release-tag) "ITableSettings" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ITableSettings {
+ // (undocumented)
+ header?: React.CSSProperties;
+ // (undocumented)
+ headerText?: ITextProps['variant'];
+ // (undocumented)
+ neighborExpandButton?: IButtonStyles;
+ // (undocumented)
+ root?: React.CSSProperties;
+ // (undocumented)
+ subheader?: React.CSSProperties;
+ // (undocumented)
+ subHeaderText?: ITextProps['variant'];
+ // (undocumented)
+ tableItems?: React.CSSProperties;
+ // (undocumented)
+ tableItemsText?: ITextProps['variant'];
+}
+
+// (No @packageDocumentation comment for this package)
+
+```
diff --git a/packages/hooks/docs/markdown/hooks.consent.advertising.md b/packages/hooks/docs/markdown/hooks.consent.advertising.md
new file mode 100644
index 00000000..a4b0fb42
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.consent.advertising.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [Consent](./hooks.consent.md) > [Advertising](./hooks.consent.advertising.md)
+
+## Consent.Advertising property
+
+Signature:
+
+```typescript
+Advertising: boolean;
+```
diff --git a/packages/hooks/docs/markdown/hooks.consent.analytics.md b/packages/hooks/docs/markdown/hooks.consent.analytics.md
new file mode 100644
index 00000000..370ff201
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.consent.analytics.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [Consent](./hooks.consent.md) > [Analytics](./hooks.consent.analytics.md)
+
+## Consent.Analytics property
+
+Signature:
+
+```typescript
+Analytics: boolean;
+```
diff --git a/packages/hooks/docs/markdown/hooks.consent.md b/packages/hooks/docs/markdown/hooks.consent.md
new file mode 100644
index 00000000..c7b98774
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.consent.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [Consent](./hooks.consent.md)
+
+## Consent interface
+
+Signature:
+
+```typescript
+export interface Consent
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [Advertising](./hooks.consent.advertising.md) | | boolean | |
+| [Analytics](./hooks.consent.analytics.md) | | boolean | |
+| [Required](./hooks.consent.required.md) | | boolean | |
+| [SocialMedia](./hooks.consent.socialmedia.md) | | boolean | |
+
diff --git a/packages/hooks/docs/markdown/hooks.consent.required.md b/packages/hooks/docs/markdown/hooks.consent.required.md
new file mode 100644
index 00000000..1ef4e764
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.consent.required.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [Consent](./hooks.consent.md) > [Required](./hooks.consent.required.md)
+
+## Consent.Required property
+
+Signature:
+
+```typescript
+Required: boolean;
+```
diff --git a/packages/hooks/docs/markdown/hooks.consent.socialmedia.md b/packages/hooks/docs/markdown/hooks.consent.socialmedia.md
new file mode 100644
index 00000000..046fe217
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.consent.socialmedia.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [Consent](./hooks.consent.md) > [SocialMedia](./hooks.consent.socialmedia.md)
+
+## Consent.SocialMedia property
+
+Signature:
+
+```typescript
+SocialMedia: boolean;
+```
diff --git a/packages/hooks/docs/markdown/hooks.consentoptions.elementid.md b/packages/hooks/docs/markdown/hooks.consentoptions.elementid.md
new file mode 100644
index 00000000..32c843d1
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.consentoptions.elementid.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [ConsentOptions](./hooks.consentoptions.md) > [elementId](./hooks.consentoptions.elementid.md)
+
+## ConsentOptions.elementId property
+
+default: 'cookie-consent'
+
+Signature:
+
+```typescript
+elementId?: string;
+```
diff --git a/packages/hooks/docs/markdown/hooks.consentoptions.md b/packages/hooks/docs/markdown/hooks.consentoptions.md
new file mode 100644
index 00000000..f526dc4e
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.consentoptions.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [ConsentOptions](./hooks.consentoptions.md)
+
+## ConsentOptions interface
+
+Signature:
+
+```typescript
+export interface ConsentOptions
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [elementId?](./hooks.consentoptions.elementid.md) | | string | (Optional) default: 'cookie-consent' |
+| [onChange?](./hooks.consentoptions.onchange.md) | | (c: [Consent](./hooks.consent.md)) => void | (Optional) |
+| [theme?](./hooks.consentoptions.theme.md) | | string | (Optional) Default: 'dark' |
+
diff --git a/packages/hooks/docs/markdown/hooks.consentoptions.onchange.md b/packages/hooks/docs/markdown/hooks.consentoptions.onchange.md
new file mode 100644
index 00000000..2d049a02
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.consentoptions.onchange.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [ConsentOptions](./hooks.consentoptions.md) > [onChange](./hooks.consentoptions.onchange.md)
+
+## ConsentOptions.onChange property
+
+Signature:
+
+```typescript
+onChange?: (c: Consent) => void;
+```
diff --git a/packages/hooks/docs/markdown/hooks.consentoptions.theme.md b/packages/hooks/docs/markdown/hooks.consentoptions.theme.md
new file mode 100644
index 00000000..2b0acf75
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.consentoptions.theme.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [ConsentOptions](./hooks.consentoptions.md) > [theme](./hooks.consentoptions.theme.md)
+
+## ConsentOptions.theme property
+
+Default: 'dark'
+
+Signature:
+
+```typescript
+theme?: string;
+```
diff --git a/packages/hooks/docs/markdown/hooks.destroyable.destroy.md b/packages/hooks/docs/markdown/hooks.destroyable.destroy.md
new file mode 100644
index 00000000..4bcf6d3c
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.destroyable.destroy.md
@@ -0,0 +1,15 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [Destroyable](./hooks.destroyable.md) > [destroy](./hooks.destroyable.destroy.md)
+
+## Destroyable.destroy() method
+
+Signature:
+
+```typescript
+destroy(): any;
+```
+Returns:
+
+any
+
diff --git a/packages/hooks/docs/markdown/hooks.destroyable.md b/packages/hooks/docs/markdown/hooks.destroyable.md
new file mode 100644
index 00000000..4cf2abf8
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.destroyable.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [Destroyable](./hooks.destroyable.md)
+
+## Destroyable interface
+
+Signature:
+
+```typescript
+export interface Destroyable
+```
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| [destroy()](./hooks.destroyable.destroy.md) | |
+
diff --git a/packages/hooks/docs/markdown/hooks.dimensions.height.md b/packages/hooks/docs/markdown/hooks.dimensions.height.md
new file mode 100644
index 00000000..a7110ecd
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.dimensions.height.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [Dimensions](./hooks.dimensions.md) > [height](./hooks.dimensions.height.md)
+
+## Dimensions.height property
+
+Signature:
+
+```typescript
+height: number;
+```
diff --git a/packages/hooks/docs/markdown/hooks.dimensions.md b/packages/hooks/docs/markdown/hooks.dimensions.md
new file mode 100644
index 00000000..bea46e6a
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.dimensions.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [Dimensions](./hooks.dimensions.md)
+
+## Dimensions interface
+
+Signature:
+
+```typescript
+export interface Dimensions
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [height](./hooks.dimensions.height.md) | | number | |
+| [width](./hooks.dimensions.width.md) | | number | |
+
diff --git a/packages/hooks/docs/markdown/hooks.dimensions.width.md b/packages/hooks/docs/markdown/hooks.dimensions.width.md
new file mode 100644
index 00000000..6db0e262
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.dimensions.width.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [Dimensions](./hooks.dimensions.md) > [width](./hooks.dimensions.width.md)
+
+## Dimensions.width property
+
+Signature:
+
+```typescript
+width: number;
+```
diff --git a/packages/hooks/docs/markdown/hooks.dynamicdata.md b/packages/hooks/docs/markdown/hooks.dynamicdata.md
new file mode 100644
index 00000000..899f0849
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.dynamicdata.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [DynamicData](./hooks.dynamicdata.md)
+
+## DynamicData type
+
+Signature:
+
+```typescript
+export type DynamicData = T | AsyncIterable;
+```
diff --git a/packages/hooks/docs/markdown/hooks.md b/packages/hooks/docs/markdown/hooks.md
new file mode 100644
index 00000000..7267b7ee
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.md
@@ -0,0 +1,42 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md)
+
+## hooks package
+
+## Functions
+
+| Function | Description |
+| --- | --- |
+| [useDestroyable(initialValue)](./hooks.usedestroyable.md) | A hook for using a destroyable thing, so when the value changes the previous value is destroyed |
+| [useDimensions(ref)](./hooks.usedimensions.md) | A hook for getting the dimensions of the given element. This hook also updates when the given element resizes. NOTE: ResizeObserver must be defined in the target runtime. BYO polyfill if it is not provided by default |
+| [useDynamicData(values, map, deps)](./hooks.usedynamicdata.md) | Hook which allows for the use of a dynamic data source |
+| [useEventListener(listenerMap, element, deps)](./hooks.useeventlistener.md) | Adds various listeners to the given element and cleans them up when done |
+| [useLongRunning(execute, delay, deps)](./hooks.uselongrunning.md) | A hook which invokes a long running task, and provides a loading flag |
+| [useMicrosoftConsentBanner({ theme, elementId, onChange, })](./hooks.usemicrosoftconsentbanner.md) | Uses the Microsoft cookie consent banner. The banner code should be loaded from CDN using a script tag. You should also include a div for the cookie banner to render into: e.g. |
+| [useMousePosition(ref, debouceTime)](./hooks.usemouseposition.md) | Gets the current mouse position on the given element |
+| [useScrollListener(listener, element, deps)](./hooks.usescrolllistener.md) | Adds a scroll listener to the given element |
+| [useSelectionHandler(equal, singleSelect)](./hooks.useselectionhandler.md) | Provides basic selection handling, |
+| [useToggle(defaultValue)](./hooks.usetoggle.md) | A hook for a toggleable state |
+
+## Interfaces
+
+| Interface | Description |
+| --- | --- |
+| [Consent](./hooks.consent.md) | |
+| [ConsentOptions](./hooks.consentoptions.md) | |
+| [Destroyable](./hooks.destroyable.md) | |
+| [Dimensions](./hooks.dimensions.md) | |
+
+## Variables
+
+| Variable | Description |
+| --- | --- |
+| [useInterval](./hooks.useinterval.md) | Creates an interval with the specified delay, and clears it on unmount. |
+
+## Type Aliases
+
+| Type Alias | Description |
+| --- | --- |
+| [DynamicData](./hooks.dynamicdata.md) | |
+
diff --git a/packages/hooks/docs/markdown/hooks.usedestroyable.md b/packages/hooks/docs/markdown/hooks.usedestroyable.md
new file mode 100644
index 00000000..70356c1d
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.usedestroyable.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useDestroyable](./hooks.usedestroyable.md)
+
+## useDestroyable() function
+
+A hook for using a destroyable thing, so when the value changes the previous value is destroyed
+
+Signature:
+
+```typescript
+export declare function useDestroyable>(initialValue?: T): [T, (state: T) => any];
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| initialValue | T | (Optional) The initial value |
+
+Returns:
+
+\[T, (state: T) => any\]
+
+The current value as well as a setter for the new value
+
diff --git a/packages/hooks/docs/markdown/hooks.usedimensions.md b/packages/hooks/docs/markdown/hooks.usedimensions.md
new file mode 100644
index 00000000..a8eee4cc
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.usedimensions.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useDimensions](./hooks.usedimensions.md)
+
+## useDimensions() function
+
+A hook for getting the dimensions of the given element. This hook also updates when the given element resizes. NOTE: ResizeObserver must be defined in the target runtime. BYO polyfill if it is not provided by default
+
+Signature:
+
+```typescript
+export declare function useDimensions(ref: MutableRefObject): Dimensions | undefined;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| ref | MutableRefObject<HTMLElement \| null> | A ref to the element to measure |
+
+Returns:
+
+[Dimensions](./hooks.dimensions.md) \| undefined
+
+The dimensions for the element.
+
diff --git a/packages/hooks/docs/markdown/hooks.usedynamicdata.md b/packages/hooks/docs/markdown/hooks.usedynamicdata.md
new file mode 100644
index 00000000..7ba712dc
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.usedynamicdata.md
@@ -0,0 +1,28 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useDynamicData](./hooks.usedynamicdata.md)
+
+## useDynamicData() function
+
+Hook which allows for the use of a dynamic data source
+
+Signature:
+
+```typescript
+export declare function useDynamicData(values?: DynamicData, map?: (values: InputType) => OutputType, deps?: any[]): OutputType | undefined;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| values | [DynamicData](./hooks.dynamicdata.md)<InputType> | (Optional) The raw set of values, or an iterator to get the values |
+| map | (values: InputType) => OutputType | (Optional) An optional mapping function which takes a list of values and transforms them |
+| deps | any\[\] | (Optional) The optional list of dependencies to use when updating the values |
+
+Returns:
+
+OutputType \| undefined
+
+The last value from the iterator
+
diff --git a/packages/hooks/docs/markdown/hooks.useeventlistener.md b/packages/hooks/docs/markdown/hooks.useeventlistener.md
new file mode 100644
index 00000000..33e9e27f
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.useeventlistener.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useEventListener](./hooks.useeventlistener.md)
+
+## useEventListener() function
+
+Adds various listeners to the given element and cleans them up when done
+
+Signature:
+
+```typescript
+export declare function useEventListener(listenerMap: ListenerMap, element: HTMLElement | Window | null | undefined, ...deps: any[]): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| listenerMap | ListenerMap | The listeners |
+| element | HTMLElement \| Window \| null \| undefined | The element to attach the listeners to |
+| deps | any\[\] | The optional list of dependencies |
+
+Returns:
+
+void
+
diff --git a/packages/hooks/docs/markdown/hooks.useinterval.md b/packages/hooks/docs/markdown/hooks.useinterval.md
new file mode 100644
index 00000000..1a273152
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.useinterval.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useInterval](./hooks.useinterval.md)
+
+## useInterval variable
+
+Creates an interval with the specified delay, and clears it on unmount.
+
+Signature:
+
+```typescript
+useInterval: (callback: () => void, delay: number) => void
+```
diff --git a/packages/hooks/docs/markdown/hooks.uselongrunning.md b/packages/hooks/docs/markdown/hooks.uselongrunning.md
new file mode 100644
index 00000000..dc0d8861
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.uselongrunning.md
@@ -0,0 +1,28 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useLongRunning](./hooks.uselongrunning.md)
+
+## useLongRunning() function
+
+A hook which invokes a long running task, and provides a loading flag
+
+Signature:
+
+```typescript
+export declare function useLongRunning(execute: () => T, delay?: number, deps?: unknown[]): [boolean, T | undefined];
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| execute | () => T | The long running task |
+| delay | number | (Optional) The delay before running the long running task (this gives react time to render a loading bar before executing the task) |
+| deps | unknown\[\] | (Optional) The optional list of dependencies |
+
+Returns:
+
+\[boolean, T \| undefined\]
+
+A loading flag and the output of the long running task
+
diff --git a/packages/hooks/docs/markdown/hooks.usemicrosoftconsentbanner.md b/packages/hooks/docs/markdown/hooks.usemicrosoftconsentbanner.md
new file mode 100644
index 00000000..6cb06523
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.usemicrosoftconsentbanner.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useMicrosoftConsentBanner](./hooks.usemicrosoftconsentbanner.md)
+
+## useMicrosoftConsentBanner() function
+
+Uses the Microsoft cookie consent banner. The banner code should be loaded from CDN using a script tag. You should also include a div for the cookie banner to render into: e.g.
+
+Signature:
+
+```typescript
+export declare function useMicrosoftConsentBanner({ theme, elementId, onChange, }?: ConsentOptions): [Consent, () => void];
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| { theme, elementId, onChange, } | [ConsentOptions](./hooks.consentoptions.md) | (Optional) |
+
+Returns:
+
+\[[Consent](./hooks.consent.md), () => void\]
+
+\[current consent; manageConsent function (to be used in footer)\]
+
diff --git a/packages/hooks/docs/markdown/hooks.usemouseposition.md b/packages/hooks/docs/markdown/hooks.usemouseposition.md
new file mode 100644
index 00000000..ec93a18b
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.usemouseposition.md
@@ -0,0 +1,27 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useMousePosition](./hooks.usemouseposition.md)
+
+## useMousePosition() function
+
+Gets the current mouse position on the given element
+
+Signature:
+
+```typescript
+export declare function useMousePosition(ref: MutableRefObject, debouceTime?: number): Position;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| ref | MutableRefObject<HTMLElement \| null> | The ref to the element |
+| debouceTime | number | (Optional) The amount of time to wait between state updates |
+
+Returns:
+
+Position
+
+The current mouse position
+
diff --git a/packages/hooks/docs/markdown/hooks.usescrolllistener.md b/packages/hooks/docs/markdown/hooks.usescrolllistener.md
new file mode 100644
index 00000000..175aa9ab
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.usescrolllistener.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useScrollListener](./hooks.usescrolllistener.md)
+
+## useScrollListener() function
+
+Adds a scroll listener to the given element
+
+Signature:
+
+```typescript
+export declare function useScrollListener(listener: Scrollistener, element?: HTMLElement | Window | null, deps?: any[]): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| listener | Scrollistener | The listener |
+| element | HTMLElement \| Window \| null | (Optional) The element to listen for scroll |
+| deps | any\[\] | (Optional) The list of optional deps |
+
+Returns:
+
+void
+
diff --git a/packages/hooks/docs/markdown/hooks.useselectionhandler.md b/packages/hooks/docs/markdown/hooks.useselectionhandler.md
new file mode 100644
index 00000000..8a5c795f
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.useselectionhandler.md
@@ -0,0 +1,27 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useSelectionHandler](./hooks.useselectionhandler.md)
+
+## useSelectionHandler() function
+
+Provides basic selection handling,
+
+Signature:
+
+```typescript
+export declare function useSelectionHandler(equal: isEqual, singleSelect: boolean): [T[], ClickHandler];
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| equal | isEqual | A object equality function |
+| singleSelect | boolean | If it should operate in single select mode |
+
+Returns:
+
+\[T\[\], ClickHandler<T>\]
+
+The list of selected objects and a handler for adding new selections
+
diff --git a/packages/hooks/docs/markdown/hooks.usetoggle.md b/packages/hooks/docs/markdown/hooks.usetoggle.md
new file mode 100644
index 00000000..99a5b577
--- /dev/null
+++ b/packages/hooks/docs/markdown/hooks.usetoggle.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [@essex/hooks](./hooks.md) > [useToggle](./hooks.usetoggle.md)
+
+## useToggle() function
+
+A hook for a toggleable state
+
+Signature:
+
+```typescript
+export declare function useToggle(defaultValue?: boolean): [boolean | undefined, () => void];
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| defaultValue | boolean | (Optional) The default value for the toggle |
+
+Returns:
+
+\[boolean \| undefined, () => void\]
+
+The current toggle state as well as a function that can be called to toggle the state
+
diff --git a/packages/hooks/docs/markdown/index.md b/packages/hooks/docs/markdown/index.md
new file mode 100644
index 00000000..bb6bc063
--- /dev/null
+++ b/packages/hooks/docs/markdown/index.md
@@ -0,0 +1,12 @@
+
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+| Package | Description |
+| --- | --- |
+| [@essex/hooks](./hooks.md) | |
+
diff --git a/packages/hooks/docs/report/hooks.api.json b/packages/hooks/docs/report/hooks.api.json
new file mode 100644
index 00000000..42b520e1
--- /dev/null
+++ b/packages/hooks/docs/report/hooks.api.json
@@ -0,0 +1,1377 @@
+{
+ "metadata": {
+ "toolPackage": "@microsoft/api-extractor",
+ "toolVersion": "7.29.2",
+ "schemaVersion": 1009,
+ "oldestForwardsCompatibleVersion": 1001,
+ "tsdocConfig": {
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+ "noStandardTags": true,
+ "tagDefinitions": [
+ {
+ "tagName": "@alpha",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@beta",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@defaultValue",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@decorator",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@deprecated",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@eventProperty",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@example",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@experimental",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@inheritDoc",
+ "syntaxKind": "inline"
+ },
+ {
+ "tagName": "@internal",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@label",
+ "syntaxKind": "inline"
+ },
+ {
+ "tagName": "@link",
+ "syntaxKind": "inline",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@override",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@packageDocumentation",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@param",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@privateRemarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@public",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@readonly",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@remarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@returns",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@sealed",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@see",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@throws",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@typeParam",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@virtual",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@betaDocumentation",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@internalRemarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@preapproved",
+ "syntaxKind": "modifier"
+ }
+ ],
+ "supportForTags": {
+ "@alpha": true,
+ "@beta": true,
+ "@defaultValue": true,
+ "@decorator": true,
+ "@deprecated": true,
+ "@eventProperty": true,
+ "@example": true,
+ "@experimental": true,
+ "@inheritDoc": true,
+ "@internal": true,
+ "@label": true,
+ "@link": true,
+ "@override": true,
+ "@packageDocumentation": true,
+ "@param": true,
+ "@privateRemarks": true,
+ "@public": true,
+ "@readonly": true,
+ "@remarks": true,
+ "@returns": true,
+ "@sealed": true,
+ "@see": true,
+ "@throws": true,
+ "@typeParam": true,
+ "@virtual": true,
+ "@betaDocumentation": true,
+ "@internalRemarks": true,
+ "@preapproved": true
+ },
+ "reportUnsupportedHtmlElements": false
+ }
+ },
+ "kind": "Package",
+ "canonicalReference": "@essex/hooks!",
+ "docComment": "",
+ "name": "@essex/hooks",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "EntryPoint",
+ "canonicalReference": "@essex/hooks!",
+ "name": "",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hooks!Consent:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface Consent "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "Consent",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hooks!Consent#Advertising:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "Advertising: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "Advertising",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hooks!Consent#Analytics:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "Analytics: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "Analytics",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hooks!Consent#Required:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "Required: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "Required",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hooks!Consent#SocialMedia:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "SocialMedia: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "SocialMedia",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hooks!ConsentOptions:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface ConsentOptions "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "ConsentOptions",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hooks!ConsentOptions#elementId:member",
+ "docComment": "/**\n * default: 'cookie-consent'\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "elementId?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "elementId",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hooks!ConsentOptions#onChange:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "onChange?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(c: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Consent",
+ "canonicalReference": "@essex/hooks!Consent:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ") => void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "onChange",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 4
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hooks!ConsentOptions#theme:member",
+ "docComment": "/**\n * Default: 'dark'\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "theme?: "
+ },
+ {
+ "kind": "Content",
+ "text": "string"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": true,
+ "releaseTag": "Public",
+ "name": "theme",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hooks!Destroyable:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface Destroyable "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "Destroyable",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "MethodSignature",
+ "canonicalReference": "@essex/hooks!Destroyable#destroy:member(1)",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "destroy(): "
+ },
+ {
+ "kind": "Content",
+ "text": "any"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isOptional": false,
+ "returnTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [],
+ "name": "destroy"
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "Interface",
+ "canonicalReference": "@essex/hooks!Dimensions:interface",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export interface Dimensions "
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "Dimensions",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hooks!Dimensions#height:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "height: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "height",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "PropertySignature",
+ "canonicalReference": "@essex/hooks!Dimensions#width:member",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "width: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "width",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "extendsTokenRanges": []
+ },
+ {
+ "kind": "TypeAlias",
+ "canonicalReference": "@essex/hooks!DynamicData:type",
+ "docComment": "",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export type DynamicData = "
+ },
+ {
+ "kind": "Content",
+ "text": "T | "
+ },
+ {
+ "kind": "Reference",
+ "text": "AsyncIterable",
+ "canonicalReference": "!AsyncIterable:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "releaseTag": "Public",
+ "name": "DynamicData",
+ "typeParameters": [
+ {
+ "typeParameterName": "T",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "typeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 4
+ }
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/hooks!useDestroyable:function(1)",
+ "docComment": "/**\n * A hook for using a destroyable thing, so when the value changes the previous value is destroyed\n *\n * @param initialValue - The initial value\n *\n * @returns The current value as well as a setter for the new value\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useDestroyable"
+ },
+ {
+ "kind": "Content",
+ "text": ">(initialValue?: "
+ },
+ {
+ "kind": "Content",
+ "text": "T"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "[T, (state: T) => any]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 9
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "initialValue",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "typeParameters": [
+ {
+ "typeParameterName": "T",
+ "constraintTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "useDestroyable"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/hooks!useDimensions:function(1)",
+ "docComment": "/**\n * A hook for getting the dimensions of the given element. This hook also updates when the given element resizes. NOTE: ResizeObserver must be defined in the target runtime. BYO polyfill if it is not provided by default\n *\n * @param ref - A ref to the element to measure\n *\n * @returns The dimensions for the element.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useDimensions(ref: "
+ },
+ {
+ "kind": "Reference",
+ "text": "MutableRefObject",
+ "canonicalReference": "@types/react!~React.MutableRefObject:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "HTMLElement",
+ "canonicalReference": "!HTMLElement:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | null>"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Dimensions",
+ "canonicalReference": "@essex/hooks!Dimensions:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | undefined"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 8
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "ref",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ }
+ ],
+ "name": "useDimensions"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/hooks!useDynamicData:function(1)",
+ "docComment": "/**\n * Hook which allows for the use of a dynamic data source\n *\n * @param values - The raw set of values, or an iterator to get the values\n *\n * @param map - An optional mapping function which takes a list of values and transforms them\n *\n * @param deps - The optional list of dependencies to use when updating the values\n *\n * @returns The last value from the iterator\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useDynamicData(values?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "DynamicData",
+ "canonicalReference": "@essex/hooks!DynamicData:type"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ", map?: "
+ },
+ {
+ "kind": "Content",
+ "text": "(values: InputType) => OutputType"
+ },
+ {
+ "kind": "Content",
+ "text": ", deps?: "
+ },
+ {
+ "kind": "Content",
+ "text": "any[]"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "OutputType | undefined"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 10,
+ "endIndex": 11
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "values",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 5
+ },
+ "isOptional": true
+ },
+ {
+ "parameterName": "map",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ },
+ {
+ "parameterName": "deps",
+ "parameterTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 9
+ },
+ "isOptional": true
+ }
+ ],
+ "typeParameters": [
+ {
+ "typeParameterName": "InputType",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ },
+ {
+ "typeParameterName": "OutputType",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ }
+ ],
+ "name": "useDynamicData"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/hooks!useEventListener:function(1)",
+ "docComment": "/**\n * Adds various listeners to the given element and cleans them up when done\n *\n * @param listenerMap - The listeners\n *\n * @param element - The element to attach the listeners to\n *\n * @param deps - The optional list of dependencies\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useEventListener(listenerMap: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ListenerMap",
+ "canonicalReference": "@essex/hooks!~ListenerMap:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ", element: "
+ },
+ {
+ "kind": "Reference",
+ "text": "HTMLElement",
+ "canonicalReference": "!HTMLElement:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | "
+ },
+ {
+ "kind": "Reference",
+ "text": "Window",
+ "canonicalReference": "!Window:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | null | undefined"
+ },
+ {
+ "kind": "Content",
+ "text": ", ...deps: "
+ },
+ {
+ "kind": "Content",
+ "text": "any[]"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 10,
+ "endIndex": 11
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "listenerMap",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "element",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 7
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "deps",
+ "parameterTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 9
+ },
+ "isOptional": false
+ }
+ ],
+ "name": "useEventListener"
+ },
+ {
+ "kind": "Variable",
+ "canonicalReference": "@essex/hooks!useInterval:var",
+ "docComment": "/**\n * Creates an interval with the specified delay, and clears it on unmount.\n *\n * @param callback - function to run on interval\n *\n * @param delay - ms delay to run callback at\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "useInterval: "
+ },
+ {
+ "kind": "Content",
+ "text": "(callback: () => void, delay: number) => void"
+ }
+ ],
+ "isReadonly": true,
+ "releaseTag": "Public",
+ "name": "useInterval",
+ "variableTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ }
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/hooks!useLongRunning:function(1)",
+ "docComment": "/**\n * A hook which invokes a long running task, and provides a loading flag\n *\n * @param execute - The long running task\n *\n * @param delay - The delay before running the long running task (this gives react time to render a loading bar before executing the task)\n *\n * @param deps - The optional list of dependencies\n *\n * @returns A loading flag and the output of the long running task\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useLongRunning(execute: "
+ },
+ {
+ "kind": "Content",
+ "text": "() => T"
+ },
+ {
+ "kind": "Content",
+ "text": ", delay?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ", deps?: "
+ },
+ {
+ "kind": "Content",
+ "text": "unknown[]"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "[boolean, T | undefined]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 7,
+ "endIndex": 8
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "execute",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "delay",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "isOptional": true
+ },
+ {
+ "parameterName": "deps",
+ "parameterTypeTokenRange": {
+ "startIndex": 5,
+ "endIndex": 6
+ },
+ "isOptional": true
+ }
+ ],
+ "typeParameters": [
+ {
+ "typeParameterName": "T",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "useLongRunning"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/hooks!useMicrosoftConsentBanner:function(1)",
+ "docComment": "/**\n * Uses the Microsoft cookie consent banner. The banner code should be loaded from CDN using a script tag. You should also include a div for the cookie banner to render into: e.g. \n *\n * @param options - The consent banner options. (optional) options.theme; \"light\" | \"dark\", default \"dark\") options.elementId; default = \"cookie-banner\" options.onChange; (consent: Consent) =\\> void; default=noop\n *\n * @returns [current consent; manageConsent function (to be used in footer)]\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useMicrosoftConsentBanner({ theme, elementId, onChange, }?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "ConsentOptions",
+ "canonicalReference": "@essex/hooks!ConsentOptions:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "["
+ },
+ {
+ "kind": "Reference",
+ "text": "Consent",
+ "canonicalReference": "@essex/hooks!Consent:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ", () => void]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 6
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "{ theme, elementId, onChange, }",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useMicrosoftConsentBanner"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/hooks!useMousePosition:function(1)",
+ "docComment": "/**\n * Gets the current mouse position on the given element\n *\n * @param ref - The ref to the element\n *\n * @param debouceTime - The amount of time to wait between state updates\n *\n * @returns The current mouse position\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useMousePosition(ref: "
+ },
+ {
+ "kind": "Reference",
+ "text": "MutableRefObject",
+ "canonicalReference": "@types/react!~React.MutableRefObject:interface"
+ },
+ {
+ "kind": "Content",
+ "text": "<"
+ },
+ {
+ "kind": "Reference",
+ "text": "HTMLElement",
+ "canonicalReference": "!HTMLElement:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | null>"
+ },
+ {
+ "kind": "Content",
+ "text": ", debouceTime?: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Position",
+ "canonicalReference": "@essex/hooks!~Position:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 9
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "ref",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 5
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "debouceTime",
+ "parameterTypeTokenRange": {
+ "startIndex": 6,
+ "endIndex": 7
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useMousePosition"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/hooks!useScrollListener:function(1)",
+ "docComment": "/**\n * Adds a scroll listener to the given element\n *\n * @param listener - The listener\n *\n * @param element - The element to listen for scroll\n *\n * @param deps - The list of optional deps\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useScrollListener(listener: "
+ },
+ {
+ "kind": "Reference",
+ "text": "Scrollistener",
+ "canonicalReference": "@essex/hooks!~Scrollistener:type"
+ },
+ {
+ "kind": "Content",
+ "text": ", element?: "
+ },
+ {
+ "kind": "Reference",
+ "text": "HTMLElement",
+ "canonicalReference": "!HTMLElement:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | "
+ },
+ {
+ "kind": "Reference",
+ "text": "Window",
+ "canonicalReference": "!Window:interface"
+ },
+ {
+ "kind": "Content",
+ "text": " | null"
+ },
+ {
+ "kind": "Content",
+ "text": ", deps?: "
+ },
+ {
+ "kind": "Content",
+ "text": "any[]"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 10,
+ "endIndex": 11
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "listener",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "element",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 7
+ },
+ "isOptional": true
+ },
+ {
+ "parameterName": "deps",
+ "parameterTypeTokenRange": {
+ "startIndex": 8,
+ "endIndex": 9
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useScrollListener"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/hooks!useSelectionHandler:function(1)",
+ "docComment": "/**\n * Provides basic selection handling,\n *\n * @param equal - A object equality function\n *\n * @param singleSelect - If it should operate in single select mode\n *\n * @returns The list of selected objects and a handler for adding new selections\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useSelectionHandler(equal: "
+ },
+ {
+ "kind": "Reference",
+ "text": "isEqual",
+ "canonicalReference": "@essex/hooks!~isEqual:type"
+ },
+ {
+ "kind": "Content",
+ "text": ", singleSelect: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "[T[], "
+ },
+ {
+ "kind": "Reference",
+ "text": "ClickHandler",
+ "canonicalReference": "@essex/hooks!~ClickHandler:type"
+ },
+ {
+ "kind": "Content",
+ "text": "]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 5,
+ "endIndex": 8
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "equal",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "singleSelect",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "isOptional": false
+ }
+ ],
+ "typeParameters": [
+ {
+ "typeParameterName": "T",
+ "constraintTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ },
+ "defaultTypeTokenRange": {
+ "startIndex": 0,
+ "endIndex": 0
+ }
+ }
+ ],
+ "name": "useSelectionHandler"
+ },
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/hooks!useToggle:function(1)",
+ "docComment": "/**\n * A hook for a toggleable state\n *\n * @param defaultValue - The default value for the toggle\n *\n * @returns The current toggle state as well as a function that can be called to toggle the state\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function useToggle(defaultValue?: "
+ },
+ {
+ "kind": "Content",
+ "text": "boolean"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Content",
+ "text": "[boolean | undefined, () => void]"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "defaultValue",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": true
+ }
+ ],
+ "name": "useToggle"
+ }
+ ]
+ }
+ ]
+}
diff --git a/packages/hooks/docs/report/hooks.api.md b/packages/hooks/docs/report/hooks.api.md
new file mode 100644
index 00000000..5aeed396
--- /dev/null
+++ b/packages/hooks/docs/report/hooks.api.md
@@ -0,0 +1,118 @@
+## API Report File for "@essex/hooks"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { MutableRefObject } from 'react';
+
+// Warning: (ae-missing-release-tag) "Consent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface Consent {
+ // (undocumented)
+ Advertising: boolean;
+ // (undocumented)
+ Analytics: boolean;
+ // (undocumented)
+ Required: boolean;
+ // (undocumented)
+ SocialMedia: boolean;
+}
+
+// Warning: (ae-missing-release-tag) "ConsentOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ConsentOptions {
+ elementId?: string;
+ // (undocumented)
+ onChange?: (c: Consent) => void;
+ theme?: string;
+}
+
+// Warning: (ae-missing-release-tag) "Destroyable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface Destroyable {
+ // (undocumented)
+ destroy(): any;
+}
+
+// Warning: (ae-missing-release-tag) "Dimensions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface Dimensions {
+ // (undocumented)
+ height: number;
+ // (undocumented)
+ width: number;
+}
+
+// Warning: (ae-missing-release-tag) "DynamicData" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type DynamicData = T | AsyncIterable;
+
+// Warning: (ae-missing-release-tag) "useDestroyable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function useDestroyable>(initialValue?: T): [T, (state: T) => any];
+
+// Warning: (ae-missing-release-tag) "useDimensions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function useDimensions(ref: MutableRefObject): Dimensions | undefined;
+
+// Warning: (ae-missing-release-tag) "useDynamicData" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function useDynamicData(values?: DynamicData, map?: (values: InputType) => OutputType, deps?: any[]): OutputType | undefined;
+
+// Warning: (ae-forgotten-export) The symbol "ListenerMap" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "useEventListener" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function useEventListener(listenerMap: ListenerMap, element: HTMLElement | Window | null | undefined, ...deps: any[]): void;
+
+// Warning: (ae-missing-release-tag) "useInterval" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export const useInterval: (callback: () => void, delay: number) => void;
+
+// Warning: (ae-missing-release-tag) "useLongRunning" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function useLongRunning(execute: () => T, delay?: number, deps?: unknown[]): [boolean, T | undefined];
+
+// Warning: (ae-missing-release-tag) "useMicrosoftConsentBanner" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function useMicrosoftConsentBanner({ theme, elementId, onChange, }?: ConsentOptions): [Consent, () => void];
+
+// Warning: (ae-forgotten-export) The symbol "Position" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "useMousePosition" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function useMousePosition(ref: MutableRefObject, debouceTime?: number): Position;
+
+// Warning: (ae-forgotten-export) The symbol "Scrollistener" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "useScrollListener" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function useScrollListener(listener: Scrollistener, element?: HTMLElement | Window | null, deps?: any[]): void;
+
+// Warning: (ae-forgotten-export) The symbol "isEqual" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "ClickHandler" needs to be exported by the entry point index.d.ts
+// Warning: (ae-missing-release-tag) "useSelectionHandler" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function useSelectionHandler(equal: isEqual, singleSelect: boolean): [T[], ClickHandler];
+
+// Warning: (ae-missing-release-tag) "useToggle" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function useToggle(defaultValue?: boolean): [boolean | undefined, () => void];
+
+// (No @packageDocumentation comment for this package)
+
+```
diff --git a/packages/msal-interactor/docs/markdown/index.md b/packages/msal-interactor/docs/markdown/index.md
new file mode 100644
index 00000000..5c146de7
--- /dev/null
+++ b/packages/msal-interactor/docs/markdown/index.md
@@ -0,0 +1,12 @@
+
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+| Package | Description |
+| --- | --- |
+| [@essex/msal-interactor](./msal-interactor.md) | |
+
diff --git a/packages/msal-interactor/docs/markdown/msal-interactor.getaccesstoken.md b/packages/msal-interactor/docs/markdown/msal-interactor.getaccesstoken.md
new file mode 100644
index 00000000..169a3370
--- /dev/null
+++ b/packages/msal-interactor/docs/markdown/msal-interactor.getaccesstoken.md
@@ -0,0 +1,30 @@
+
+
+[Home](./index.md) > [@essex/msal-interactor](./msal-interactor.md) > [getAccessToken](./msal-interactor.getaccesstoken.md)
+
+## getAccessToken() function
+
+Retrieves an access token for the currently logged in user
+
+Signature:
+
+```typescript
+export declare function getAccessToken(instance: IPublicClientApplication, account: AccountInfo, scopes: string[]): Promise;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| instance | IPublicClientApplication | |
+| account | AccountInfo | |
+| scopes | string\[\] | |
+
+Returns:
+
+Promise<string>
+
+## Exceptions
+
+when unable to fetch a token ia retry
+
diff --git a/packages/msal-interactor/docs/markdown/msal-interactor.md b/packages/msal-interactor/docs/markdown/msal-interactor.md
new file mode 100644
index 00000000..5197ba38
--- /dev/null
+++ b/packages/msal-interactor/docs/markdown/msal-interactor.md
@@ -0,0 +1,12 @@
+
+
+[Home](./index.md) > [@essex/msal-interactor](./msal-interactor.md)
+
+## msal-interactor package
+
+## Functions
+
+| Function | Description |
+| --- | --- |
+| [getAccessToken(instance, account, scopes)](./msal-interactor.getaccesstoken.md) | Retrieves an access token for the currently logged in user |
+
diff --git a/packages/msal-interactor/docs/report/msal-interactor.api.json b/packages/msal-interactor/docs/report/msal-interactor.api.json
new file mode 100644
index 00000000..53cd7b44
--- /dev/null
+++ b/packages/msal-interactor/docs/report/msal-interactor.api.json
@@ -0,0 +1,261 @@
+{
+ "metadata": {
+ "toolPackage": "@microsoft/api-extractor",
+ "toolVersion": "7.29.2",
+ "schemaVersion": 1009,
+ "oldestForwardsCompatibleVersion": 1001,
+ "tsdocConfig": {
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+ "noStandardTags": true,
+ "tagDefinitions": [
+ {
+ "tagName": "@alpha",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@beta",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@defaultValue",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@decorator",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@deprecated",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@eventProperty",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@example",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@experimental",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@inheritDoc",
+ "syntaxKind": "inline"
+ },
+ {
+ "tagName": "@internal",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@label",
+ "syntaxKind": "inline"
+ },
+ {
+ "tagName": "@link",
+ "syntaxKind": "inline",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@override",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@packageDocumentation",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@param",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@privateRemarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@public",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@readonly",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@remarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@returns",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@sealed",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@see",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@throws",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@typeParam",
+ "syntaxKind": "block",
+ "allowMultiple": true
+ },
+ {
+ "tagName": "@virtual",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@betaDocumentation",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@internalRemarks",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@preapproved",
+ "syntaxKind": "modifier"
+ }
+ ],
+ "supportForTags": {
+ "@alpha": true,
+ "@beta": true,
+ "@defaultValue": true,
+ "@decorator": true,
+ "@deprecated": true,
+ "@eventProperty": true,
+ "@example": true,
+ "@experimental": true,
+ "@inheritDoc": true,
+ "@internal": true,
+ "@label": true,
+ "@link": true,
+ "@override": true,
+ "@packageDocumentation": true,
+ "@param": true,
+ "@privateRemarks": true,
+ "@public": true,
+ "@readonly": true,
+ "@remarks": true,
+ "@returns": true,
+ "@sealed": true,
+ "@see": true,
+ "@throws": true,
+ "@typeParam": true,
+ "@virtual": true,
+ "@betaDocumentation": true,
+ "@internalRemarks": true,
+ "@preapproved": true
+ },
+ "reportUnsupportedHtmlElements": false
+ }
+ },
+ "kind": "Package",
+ "canonicalReference": "@essex/msal-interactor!",
+ "docComment": "",
+ "name": "@essex/msal-interactor",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "EntryPoint",
+ "canonicalReference": "@essex/msal-interactor!",
+ "name": "",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "Function",
+ "canonicalReference": "@essex/msal-interactor!getAccessToken:function(1)",
+ "docComment": "/**\n * Retrieves an access token for the currently logged in user\n *\n * @throws\n *\n * when unable to fetch a token ia retry\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare function getAccessToken(instance: "
+ },
+ {
+ "kind": "Reference",
+ "text": "IPublicClientApplication",
+ "canonicalReference": "@azure/msal-browser!IPublicClientApplication:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ", account: "
+ },
+ {
+ "kind": "Reference",
+ "text": "AccountInfo",
+ "canonicalReference": "@azure/msal-common!AccountInfo:type"
+ },
+ {
+ "kind": "Content",
+ "text": ", scopes: "
+ },
+ {
+ "kind": "Content",
+ "text": "string[]"
+ },
+ {
+ "kind": "Content",
+ "text": "): "
+ },
+ {
+ "kind": "Reference",
+ "text": "Promise",
+ "canonicalReference": "!Promise:interface"
+ },
+ {
+ "kind": "Content",
+ "text": ""
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "returnTypeTokenRange": {
+ "startIndex": 7,
+ "endIndex": 9
+ },
+ "releaseTag": "Public",
+ "overloadIndex": 1,
+ "parameters": [
+ {
+ "parameterName": "instance",
+ "parameterTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "account",
+ "parameterTypeTokenRange": {
+ "startIndex": 3,
+ "endIndex": 4
+ },
+ "isOptional": false
+ },
+ {
+ "parameterName": "scopes",
+ "parameterTypeTokenRange": {
+ "startIndex": 5,
+ "endIndex": 6
+ },
+ "isOptional": false
+ }
+ ],
+ "name": "getAccessToken"
+ }
+ ]
+ }
+ ]
+}
diff --git a/packages/msal-interactor/docs/report/msal-interactor.api.md b/packages/msal-interactor/docs/report/msal-interactor.api.md
new file mode 100644
index 00000000..2be59537
--- /dev/null
+++ b/packages/msal-interactor/docs/report/msal-interactor.api.md
@@ -0,0 +1,17 @@
+## API Report File for "@essex/msal-interactor"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { AccountInfo } from '@azure/msal-browser';
+import type { IPublicClientApplication } from '@azure/msal-browser';
+
+// Warning: (ae-missing-release-tag) "getAccessToken" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function getAccessToken(instance: IPublicClientApplication, account: AccountInfo, scopes: string[]): Promise;
+
+// (No @packageDocumentation comment for this package)
+
+```
diff --git a/packages/semantic-components/docs/markdown/index.md b/packages/semantic-components/docs/markdown/index.md
new file mode 100644
index 00000000..952ea47f
--- /dev/null
+++ b/packages/semantic-components/docs/markdown/index.md
@@ -0,0 +1,12 @@
+
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+| Package | Description |
+| --- | --- |
+| [@essex/semantic-components](./semantic-components.md) | |
+
diff --git a/packages/semantic-components/docs/markdown/semantic-components.defaulted.md b/packages/semantic-components/docs/markdown/semantic-components.defaulted.md
new file mode 100644
index 00000000..7fa86c58
--- /dev/null
+++ b/packages/semantic-components/docs/markdown/semantic-components.defaulted.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [@essex/semantic-components](./semantic-components.md) > [Defaulted](./semantic-components.defaulted.md)
+
+## Defaulted type
+
+Signature:
+
+```typescript
+export type Defaulted = Partial & Omit