@mantine/spotlight 3.7.0-alpha.0

package/lib/DefaultAction/DefaultAction.styles.d.ts

@@ -0,0 +1,7 @@
+declare const _default: (params: void, options?: import("@mantine/core").UseStylesOptions<"action" | "actionHovered" | "actionIcon" | "actionBody">) => {
+    classes: Record<"action" | "actionHovered" | "actionIcon" | "actionBody", string>;
+    cx: (...args: any) => string;
+    theme: import("@mantine/core").MantineTheme;
+};
+export default _default;
+//# sourceMappingURL=DefaultAction.styles.d.ts.map

package/lib/DefaultAction/DefaultAction.styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultAction.styles.d.ts","sourceRoot":"","sources":["../../src/DefaultAction/DefaultAction.styles.ts"],"names":[],"mappings":";;;;;AAEA,wBAoBI"}

package/lib/Spotlight/Spotlight.d.ts

@@ -0,0 +1,64 @@
+import React from 'react';
+import { MantineTransition, DefaultProps, ClassNames, MantineShadow } from '@mantine/core';
+import { DefaultActionProps } from '../DefaultAction/DefaultAction';
+import { ActionsListStylesNames } from '../ActionsList/ActionsList';
+import type { SpotlightAction } from '../types';
+import useStyles from './Spotlight.styles';
+export declare type SpotlightStylesNames = ClassNames<typeof useStyles> | ActionsListStylesNames;
+export interface InnerSpotlightProps extends DefaultProps<SpotlightStylesNames>, React.ComponentPropsWithoutRef<'div'> {
+    /** Should spotlight be rendered within Portal */
+    withinPortal?: boolean;
+    /** Premade transition or transition object */
+    transition?: MantineTransition;
+    /** Transition duration in ms, set to 0 to disable all transitions */
+    transitionDuration?: number;
+    /** Backdrop overlay color, e.g. #000 */
+    overlayColor?: string;
+    /** Backdrop overlay opacity (0-1), e.g. 0.65 */
+    overlayOpacity?: number;
+    /** Backdrop overlay blur in px */
+    overlayBlur?: number;
+    /** Value from theme.shadows or any valid css box-shadow value */
+    shadow?: MantineShadow;
+    /** Should spotlight be rendered in the center of the screen */
+    centered?: boolean;
+    /** Max spotlight width */
+    maxWidth?: number;
+    /** Top offset when spotlight is not centered */
+    topOffset?: number;
+    /** Search input placeholder */
+    searchPlaceholder?: string;
+    /** Search input icon */
+    searchIcon?: React.ReactNode;
+    /** Function used to determine how actions will be filtered based on user input */
+    filter?(query: string, actions: SpotlightAction[]): SpotlightAction[];
+    /** Message displayed when actions were not found */
+    nothingFoundMessage?: React.ReactNode;
+    /** Number of actions displayed at a time */
+    limit?: number;
+    /** Should spotlight be closed when action is triggered */
+    closeOnActionTrigger?: boolean;
+    /** Component that is used to render actions */
+    actionComponent?: React.FC<DefaultActionProps>;
+    /** Component that is used to wrap actions list */
+    actionsWrapperComponent?: React.FC<{
+        children: React.ReactNode;
+    }> | string;
+    /** Spotlight z-index */
+    zIndex?: number;
+    /** Should user query be highlighted in actions title */
+    highlightQuery?: boolean;
+}
+interface SpotlightProps extends InnerSpotlightProps {
+    actions: SpotlightAction[];
+    onClose(): void;
+    opened: boolean;
+    query: string;
+    onQueryChange(query: string): void;
+}
+export declare function Spotlight({ query, onQueryChange, actions, onClose, opened, withinPortal, transition, transitionDuration, classNames, styles, overlayColor, overlayOpacity, overlayBlur, shadow, centered, closeOnActionTrigger, highlightQuery, maxWidth, topOffset, className, searchPlaceholder, searchIcon, filter, nothingFoundMessage, limit, actionComponent, actionsWrapperComponent: ActionsWrapper, zIndex, ...others }: SpotlightProps): JSX.Element;
+export declare namespace Spotlight {
+    var displayName: string;
+}
+export {};
+//# sourceMappingURL=Spotlight.d.ts.map

package/lib/Spotlight/Spotlight.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Spotlight.d.ts","sourceRoot":"","sources":["../../src/Spotlight/Spotlight.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAmB,MAAM,OAAO,CAAC;AACxC,OAAO,EAGL,iBAAiB,EAGjB,YAAY,EACZ,UAAU,EACV,aAAa,EAGd,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAiB,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,EAAe,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACjF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAE3C,oBAAY,oBAAoB,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,GAAG,sBAAsB,CAAC;AAEzF,MAAM,WAAW,mBACf,SAAQ,YAAY,CAAC,oBAAoB,CAAC,EACxC,KAAK,CAAC,wBAAwB,CAAC,KAAK,CAAC;IACvC,iDAAiD;IACjD,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,8CAA8C;IAC9C,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAE/B,qEAAqE;IACrE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,wCAAwC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iEAAiE;IACjE,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,+BAA+B;IAC/B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,wBAAwB;IACxB,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAE7B,kFAAkF;IAClF,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,eAAe,EAAE,CAAC;IAEtE,oDAAoD;IACpD,mBAAmB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAEtC,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B,+CAA+C;IAC/C,eAAe,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;IAE/C,kDAAkD;IAClD,uBAAuB,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;QAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAAE,CAAC,GAAG,MAAM,CAAC;IAE3E,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,wDAAwD;IACxD,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,UAAU,cAAe,SAAQ,mBAAmB;IAClD,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,OAAO,IAAI,IAAI,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,wBAAgB,SAAS,CAAC,EACxB,KAAK,EACL,aAAa,EACb,OAAO,EACP,OAAO,EACP,MAAM,EACN,YAAY,EACZ,UAAkB,EAClB,kBAAkB,EAClB,UAAU,EACV,MAAM,EACN,YAAqB,EACrB,cAAqB,EACrB,WAAe,EACf,MAAa,EACb,QAAgB,EAChB,oBAA2B,EAC3B,cAAsB,EACtB,QAAc,EACd,SAAe,EACf,SAAS,EACT,iBAAiB,EACjB,UAAU,EACV,MAAsB,EACtB,mBAAmB,EACnB,KAAU,EACV,eAA+B,EAC/B,uBAAuB,EAAE,cAAsB,EAC/C,MAAkC,EAClC,GAAG,MAAM,EACV,EAAE,cAAc,eAyIhB;yBAvKe,SAAS"}

package/lib/Spotlight/Spotlight.styles.d.ts

@@ -0,0 +1,12 @@
+export interface SpotlightStylesParams {
+    centered: boolean;
+    maxWidth: number;
+    topOffset: number;
+}
+declare const _default: (params: SpotlightStylesParams, options?: import("@mantine/core").UseStylesOptions<"root" | "spotlight" | "overlay" | "inner" | "searchInput">) => {
+    classes: Record<"root" | "spotlight" | "overlay" | "inner" | "searchInput", string>;
+    cx: (...args: any) => string;
+    theme: import("@mantine/core").MantineTheme;
+};
+export default _default;
+//# sourceMappingURL=Spotlight.styles.d.ts.map

package/lib/Spotlight/Spotlight.styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Spotlight.styles.d.ts","sourceRoot":"","sources":["../../src/Spotlight/Spotlight.styles.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;;;;;;AAED,wBAoCI"}

package/lib/Spotlight/filter-actions/filter-actions.d.ts

@@ -0,0 +1,3 @@
+import type { SpotlightAction } from '../../types';
+export declare function filterActions(_query: string, actions: SpotlightAction[]): SpotlightAction[];
+//# sourceMappingURL=filter-actions.d.ts.map

package/lib/Spotlight/filter-actions/filter-actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-actions.d.ts","sourceRoot":"","sources":["../../../src/Spotlight/filter-actions/filter-actions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAkBnD,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,qBAQvE"}

package/lib/Spotlight.context.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="react" />
+import type { SpotlightAction } from './types';
+export interface SpotlightContextProps {
+    /** Opens spotlight */
+    openSpotlight(): void;
+    /** Closes spotlight */
+    closeSpotlight(): void;
+    /** Toggles spotlight opened state */
+    toggleSpotlight(): void;
+    /** Triggers action with given id */
+    triggerAction(actionId: string): void;
+    /** Registers additional actions */
+    registerActions(action: SpotlightAction[]): void;
+    /** Removes actions with given ids */
+    removeActions(actionIds: string[]): void;
+    /** Current opened state */
+    opened: boolean;
+    /** List of registered actions */
+    actions: SpotlightAction[];
+    /** Search query */
+    query: string;
+}
+export declare const SpotlightContext: import("react").Context<SpotlightContextProps>;
+export declare function useSpotlight(): SpotlightContextProps;
+//# sourceMappingURL=Spotlight.context.d.ts.map

package/lib/Spotlight.context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Spotlight.context.d.ts","sourceRoot":"","sources":["../src/Spotlight.context.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,MAAM,WAAW,qBAAqB;IACpC,sBAAsB;IACtB,aAAa,IAAI,IAAI,CAAC;IAEtB,uBAAuB;IACvB,cAAc,IAAI,IAAI,CAAC;IAEvB,qCAAqC;IACrC,eAAe,IAAI,IAAI,CAAC;IAExB,oCAAoC;IACpC,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,mCAAmC;IACnC,eAAe,CAAC,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IAEjD,qCAAqC;IACrC,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEzC,2BAA2B;IAC3B,MAAM,EAAE,OAAO,CAAC;IAEhB,iCAAiC;IACjC,OAAO,EAAE,eAAe,EAAE,CAAC;IAE3B,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,gBAAgB,gDAA6C,CAAC;AAE3E,wBAAgB,YAAY,0BAQ3B"}

package/lib/SpotlightProvider.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+import { InnerSpotlightProps } from './Spotlight/Spotlight';
+import type { SpotlightAction } from './types';
+export interface SpotlightProviderProps extends InnerSpotlightProps {
+    /** Actions list */
+    actions: SpotlightAction[] | ((query: string) => SpotlightAction[]);
+    /** Your application */
+    children?: React.ReactNode;
+    /** Called when spotlight opens */
+    onSpotlightOpen?(): void;
+    /** Called when spotlight closes */
+    onSpotlightClose?(): void;
+    /** Called when user enters text in search input */
+    onQueryChange?(query: string): void;
+    /** Keyboard shortcut or list of shortcuts to trigger spotlight */
+    shortcut?: string | string[] | null;
+    /** Should search be cleared when spotlight closes */
+    cleanQueryOnClose?: boolean;
+}
+export declare function SpotlightProvider({ actions: initialActions, children, shortcut, onSpotlightClose, onSpotlightOpen, onQueryChange, cleanQueryOnClose, transitionDuration, ...others }: SpotlightProviderProps): JSX.Element;
+export declare namespace SpotlightProvider {
+    var displayName: string;
+}
+//# sourceMappingURL=SpotlightProvider.d.ts.map

package/lib/SpotlightProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpotlightProvider.d.ts","sourceRoot":"","sources":["../src/SpotlightProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA2B,MAAM,OAAO,CAAC;AAIhD,OAAO,EAAa,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAG/C,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,mBAAmB;IACnB,OAAO,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,EAAE,CAAC,CAAC;IAEpE,uBAAuB;IACvB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAE3B,kCAAkC;IAClC,eAAe,CAAC,IAAI,IAAI,CAAC;IAEzB,mCAAmC;IACnC,gBAAgB,CAAC,IAAI,IAAI,CAAC;IAE1B,mDAAmD;IACnD,aAAa,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,kEAAkE;IAClE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IAEpC,qDAAqD;IACrD,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,wBAAgB,iBAAiB,CAAC,EAChC,OAAO,EAAE,cAAc,EACvB,QAAQ,EACR,QAAoB,EACpB,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,iBAAwB,EACxB,kBAAwB,EACxB,GAAG,MAAM,EACV,EAAE,sBAAsB,eAwDxB;yBAlEe,iBAAiB"}

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+export { useSpotlight } from './Spotlight.context';
+export { SpotlightProvider } from './SpotlightProvider';
+export type { SpotlightAction } from './types';
+export type { SpotlightProviderProps } from './SpotlightProvider';
+export type { DefaultActionProps as SpotlightActionProps } from './DefaultAction/DefaultAction';
+export type { SpotlightStylesNames } from './Spotlight/Spotlight';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC/C,YAAY,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAClE,YAAY,EAAE,kBAAkB,IAAI,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAChG,YAAY,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC"}

package/lib/types.d.ts

@@ -0,0 +1,20 @@
+import type { ReactNode } from 'react';
+export interface SpotlightAction {
+    /** Action id, may be used to trigger action or find it in actions array, if not provided random string will be generated instead */
+    id?: string;
+    /** Action title, topmost large text, used for default filtering */
+    title: string;
+    /** Action description, small text displayed after title, used for default filtering */
+    description?: string;
+    /** Action group, used to render group label */
+    group?: string;
+    /** Keywords that are used for default filtering, not displayed anywhere, can be a string: "react,router,javascript" or an array: ['react', 'router', 'javascript'] */
+    keywords?: string | string[];
+    /** Decorative icon */
+    icon?: ReactNode;
+    /** Function that is called when action is triggered */
+    onTrigger(action: SpotlightAction): void;
+    /** Any other properties that will be consumed by SpotlightProvider */
+    [key: string]: any;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC,MAAM,WAAW,eAAe;IAC9B,oIAAoI;IACpI,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,mEAAmE;IACnE,KAAK,EAAE,MAAM,CAAC;IAEd,uFAAuF;IACvF,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,sKAAsK;IACtK,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE7B,sBAAsB;IACtB,IAAI,CAAC,EAAE,SAAS,CAAC;IAEjB,uDAAuD;IACvD,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC;IAEzC,sEAAsE;IACtE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB"}

package/lib/use-actions-state/use-actions-state.d.ts

@@ -0,0 +1,7 @@
+import type { SpotlightAction } from '../types';
+export declare function useActionsState(initialActions: SpotlightAction[] | ((query: string) => SpotlightAction[]), query: string): readonly [SpotlightAction[], {
+    readonly registerActions: (payload: SpotlightAction[]) => void;
+    readonly removeActions: (ids: string[]) => void;
+    readonly triggerAction: (id: string) => void;
+}];
+//# sourceMappingURL=use-actions-state.d.ts.map

package/lib/use-actions-state/use-actions-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-actions-state.d.ts","sourceRoot":"","sources":["../../src/use-actions-state/use-actions-state.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAyBhD,wBAAgB,eAAe,CAC7B,cAAc,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,eAAe,EAAE,CAAC,EAC1E,KAAK,EAAE,MAAM;wCAYqB,eAAe,EAAE;kCAGvB,MAAM,EAAE;iCAGT,MAAM;GAalC"}

package/lib/use-spotlight-shortcuts/use-spotlight-shortcuts.d.ts

@@ -0,0 +1,4 @@
+import { HotkeyItem } from '@mantine/hooks';
+export declare function getHotkeysPayload(shortcuts: string | string[], onToggle: () => void): HotkeyItem[];
+export declare function useSpotlightShortcuts(shortcuts: string | string[], onToggle: () => void): void;
+//# sourceMappingURL=use-spotlight-shortcuts.d.ts.map

package/lib/use-spotlight-shortcuts/use-spotlight-shortcuts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-spotlight-shortcuts.d.ts","sourceRoot":"","sources":["../../src/use-spotlight-shortcuts/use-spotlight-shortcuts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAExD,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAC5B,QAAQ,EAAE,MAAM,IAAI,GACnB,UAAU,EAAE,CAUd;AAED,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAI,QAEvF"}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@mantine/spotlight",
+  "description": "Command center for your application",
+  "version": "3.7.0-alpha.0",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "types": "lib/index.d.ts",
+  "license": "MIT",
+  "author": "Vitaly Rtishchev <rtivital@gmail.com>",
+  "sideEffects": false,
+  "homepage": "https://mantine.dev/others/notifications/",
+  "repository": {
+    "url": "https://github.com/mantinedev/mantine.git",
+    "type": "git",
+    "directory": "src/mantine-notifications"
+  },
+  "peerDependencies": {
+    "@mantine/core": "3.7.0-alpha.0",
+    "@mantine/hooks": "3.7.0-alpha.0",
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0"
+  },
+  "dependencies": {},
+  "devDependencies": {}
+}