@nimbus-ds/patterns 1.22.0 → 1.23.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -104,7 +104,12 @@ export type AppShellMenuContextValue = {
104
104
  /** Useful boolean to know if the menu is rendered as a popover/flyout. */
105
105
  isMenuPopover: boolean;
106
106
  };
107
- export declare const useAppShellMenuContext: () => AppShellMenuContextValue;
107
+ /**
108
+ * Read AppShellMenuContext state. Useful to know if the menu is rendered as a popover/flyout.
109
+ * @param enforce When false, returns a default value (false) if no provider is present. Adviced not to abuse, but useful for menu that Menu components that aren't always inside an AppShell.
110
+ * @throws If `enforce=true` and used without a provider.
111
+ */
112
+ export declare const useAppShellMenuContext: (enforce?: boolean) => AppShellMenuContextValue;
108
113
  export interface CalloutCardProperties {
109
114
  /**
110
115
  * CalloutCard color.