@mantine/spotlight 7.13.5-alpha.0 → 7.13.5-alpha.2

package/lib/SpotlightRoot.d.ts

@@ -0,0 +1,45 @@
+import { Factory, ModalProps, ModalStylesNames, StylesApiProps } from '@mantine/core';
+import { SpotlightStore } from './spotlight.store';
+export type SpotlightRootStylesNames = ModalStylesNames | 'search' | 'actionsList' | 'action' | 'empty' | 'footer' | 'actionBody' | 'actionLabel' | 'actionDescription' | 'actionSection' | 'actionsGroup';
+export interface SpotlightRootProps extends StylesApiProps<SpotlightRootFactory>, Omit<ModalProps, 'styles' | 'classNames' | 'vars' | 'variant' | 'opened' | 'onClose' | 'closeButtonProps' | 'withCloseButton'> {
+    /** Spotlight store, can be used to create multiple instances of spotlight */
+    store?: SpotlightStore;
+    /** Controlled Spotlight search query */
+    query?: string;
+    /** Called when query changes */
+    onQueryChange?: (query: string) => void;
+    /** Determines whether the search query should be cleared when the spotlight is closed, `true` by default */
+    clearQueryOnClose?: boolean;
+    /** Keyboard shortcut or a list of shortcuts to trigger spotlight, `'mod + K'` by default */
+    shortcut?: string | string[] | null;
+    /** A list of tags which when focused will be ignored by shortcut, `['input', 'textarea', 'select']` by default */
+    tagsToIgnore?: string[];
+    /** Determines whether shortcut should trigger based in contentEditable, `false` by default */
+    triggerOnContentEditable?: boolean;
+    /** If set, spotlight will not be rendered */
+    disabled?: boolean;
+    /** Called when spotlight opens */
+    onSpotlightOpen?: () => void;
+    /** Called when spotlight closes */
+    onSpotlightClose?: () => void;
+    /** Forces opened state, useful for tests */
+    forceOpened?: boolean;
+    /** Determines whether spotlight should be closed when one of the actions is triggered, `true` by default */
+    closeOnActionTrigger?: boolean;
+    /** Spotlight content max-height. Ignored unless `scrollable` prop is set. `400` by default */
+    maxHeight?: React.CSSProperties['maxHeight'];
+    /** Determines whether the actions list should be scrollable. If not set, `maxHeight` is ignored, `false` by default */
+    scrollable?: boolean;
+}
+export type SpotlightRootFactory = Factory<{
+    props: SpotlightRootProps;
+    ref: HTMLDivElement;
+    stylesNames: SpotlightRootStylesNames;
+    compound: true;
+}>;
+export declare const SpotlightRoot: import("@mantine/core").MantineComponent<{
+    props: SpotlightRootProps;
+    ref: HTMLDivElement;
+    stylesNames: SpotlightRootStylesNames;
+    compound: true;
+}>;

package/lib/SpotlightSearch.d.ts

@@ -0,0 +1,16 @@
+import { BoxProps, CompoundStylesApiProps, ElementProps, Factory, InputProps, InputStylesNames } from '@mantine/core';
+export type SpotlightSearchStylesNames = InputStylesNames;
+export interface SpotlightSearchProps extends BoxProps, Omit<InputProps, 'classNames' | 'styles' | 'vars' | 'variant'>, CompoundStylesApiProps<SpotlightSearchFactory>, ElementProps<'input', 'size'> {
+}
+export type SpotlightSearchFactory = Factory<{
+    props: SpotlightSearchProps;
+    ref: HTMLInputElement;
+    stylesNames: SpotlightSearchStylesNames;
+    compound: true;
+}>;
+export declare const SpotlightSearch: import("@mantine/core").MantineComponent<{
+    props: SpotlightSearchProps;
+    ref: HTMLInputElement;
+    stylesNames: SpotlightSearchStylesNames;
+    compound: true;
+}>;

package/lib/default-spotlight-filter.d.ts

@@ -0,0 +1,2 @@
+import type { SpotlightFilterFunction } from './Spotlight';
+export declare const defaultSpotlightFilter: SpotlightFilterFunction;

package/lib/get-hotkeys.d.ts

@@ -0,0 +1,3 @@
+import { HotkeyItem } from '@mantine/hooks';
+import { SpotlightStore } from './spotlight.store';
+export declare function getHotkeys(hotkeys: string | string[] | null | undefined, store: SpotlightStore): HotkeyItem[];

package/lib/index.d.mts

@@ -0,0 +1,19 @@
+export { spotlight, createSpotlight, createSpotlightStore, useSpotlight, openSpotlight, closeSpotlight, toggleSpotlight, } from './spotlight.store';
+export type { SpotlightState, SpotlightStore } from './spotlight.store';
+export { isActionsGroup } from './is-actions-group';
+export { Spotlight } from './Spotlight';
+export { SpotlightRoot } from './SpotlightRoot';
+export { SpotlightAction } from './SpotlightAction';
+export { SpotlightActionsGroup } from './SpotlightActionsGroup';
+export { SpotlightActionsList } from './SpotlightActionsList';
+export { SpotlightEmpty } from './SpotlightEmpty';
+export { SpotlightFooter } from './SpotlightFooter';
+export { SpotlightSearch } from './SpotlightSearch';
+export type { SpotlightFactory, SpotlightFilterFunction, SpotlightActionData, SpotlightActionGroupData, SpotlightProps, SpotlightStylesNames, } from './Spotlight';
+export type { SpotlightActionProps, SpotlightActionStylesNames } from './SpotlightAction';
+export type { SpotlightActionsGroupProps, SpotlightActionsGroupStylesNames, } from './SpotlightActionsGroup';
+export type { SpotlightActionsListProps, SpotlightActionsListStylesNames, } from './SpotlightActionsList';
+export type { SpotlightEmptyProps, SpotlightEmptyStylesNames } from './SpotlightEmpty';
+export type { SpotlightFooterProps, SpotlightFooterStylesNames } from './SpotlightFooter';
+export type { SpotlightSearchProps, SpotlightSearchStylesNames } from './SpotlightSearch';
+export type { SpotlightRootProps, SpotlightRootStylesNames } from './SpotlightRoot';

package/lib/index.d.ts

@@ -0,0 +1,19 @@
+export { spotlight, createSpotlight, createSpotlightStore, useSpotlight, openSpotlight, closeSpotlight, toggleSpotlight, } from './spotlight.store';
+export type { SpotlightState, SpotlightStore } from './spotlight.store';
+export { isActionsGroup } from './is-actions-group';
+export { Spotlight } from './Spotlight';
+export { SpotlightRoot } from './SpotlightRoot';
+export { SpotlightAction } from './SpotlightAction';
+export { SpotlightActionsGroup } from './SpotlightActionsGroup';
+export { SpotlightActionsList } from './SpotlightActionsList';
+export { SpotlightEmpty } from './SpotlightEmpty';
+export { SpotlightFooter } from './SpotlightFooter';
+export { SpotlightSearch } from './SpotlightSearch';
+export type { SpotlightFactory, SpotlightFilterFunction, SpotlightActionData, SpotlightActionGroupData, SpotlightProps, SpotlightStylesNames, } from './Spotlight';
+export type { SpotlightActionProps, SpotlightActionStylesNames } from './SpotlightAction';
+export type { SpotlightActionsGroupProps, SpotlightActionsGroupStylesNames, } from './SpotlightActionsGroup';
+export type { SpotlightActionsListProps, SpotlightActionsListStylesNames, } from './SpotlightActionsList';
+export type { SpotlightEmptyProps, SpotlightEmptyStylesNames } from './SpotlightEmpty';
+export type { SpotlightFooterProps, SpotlightFooterStylesNames } from './SpotlightFooter';
+export type { SpotlightSearchProps, SpotlightSearchStylesNames } from './SpotlightSearch';
+export type { SpotlightRootProps, SpotlightRootStylesNames } from './SpotlightRoot';

package/lib/is-actions-group.d.ts

@@ -0,0 +1,2 @@
+import type { SpotlightActionData, SpotlightActionGroupData } from './Spotlight';
+export declare function isActionsGroup(item: SpotlightActionData | SpotlightActionGroupData): item is SpotlightActionGroupData;

package/lib/limit-actions.d.ts

@@ -0,0 +1,2 @@
+import type { SpotlightActions } from './Spotlight';
+export declare function limitActions(actions: SpotlightActions[], limit: number): SpotlightActions[];

package/lib/spotlight.store.d.ts

@@ -0,0 +1,53 @@
+import { MantineStore } from '@mantine/store';
+export interface SpotlightState {
+    opened: boolean;
+    selected: number;
+    listId: string;
+    query: string;
+    empty: boolean;
+    registeredActions: Set<string>;
+}
+export type SpotlightStore = MantineStore<SpotlightState>;
+export declare const createSpotlightStore: () => MantineStore<SpotlightState>;
+export declare const useSpotlight: (store: SpotlightStore) => SpotlightState;
+export declare function updateSpotlightStateAction(update: (state: SpotlightState) => Partial<SpotlightState>, store: SpotlightStore): void;
+export declare function openSpotlightAction(store: SpotlightStore): void;
+export declare function closeSpotlightAction(store: SpotlightStore): void;
+export declare function toggleSpotlightAction(store: SpotlightStore): void;
+export declare function setSelectedAction(index: number, store: SpotlightStore): void;
+export declare function setListId(id: string, store: SpotlightStore): void;
+export declare function selectAction(index: number, store: SpotlightStore): number;
+export declare function selectNextAction(store: SpotlightStore): number;
+export declare function selectPreviousAction(store: SpotlightStore): number;
+export declare function triggerSelectedAction(store: SpotlightStore): void;
+export declare function registerAction(id: string, store: SpotlightStore): () => void;
+export declare function setQuery(query: string, store: SpotlightStore): void;
+export declare function clearSpotlightState({ clearQuery }: {
+    clearQuery: boolean | undefined;
+}, store: SpotlightStore): void;
+export declare const spotlightActions: {
+    open: typeof openSpotlightAction;
+    close: typeof closeSpotlightAction;
+    toggle: typeof toggleSpotlightAction;
+    updateState: typeof updateSpotlightStateAction;
+    setSelectedAction: typeof setSelectedAction;
+    setListId: typeof setListId;
+    selectAction: typeof selectAction;
+    selectNextAction: typeof selectNextAction;
+    selectPreviousAction: typeof selectPreviousAction;
+    triggerSelectedAction: typeof triggerSelectedAction;
+    registerAction: typeof registerAction;
+    setQuery: typeof setQuery;
+    clearSpotlightState: typeof clearSpotlightState;
+};
+export declare function createSpotlight(): readonly [MantineStore<SpotlightState>, {
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+}];
+export declare const spotlightStore: MantineStore<SpotlightState>, spotlight: {
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+};
+export declare const openSpotlight: () => void, closeSpotlight: () => void, toggleSpotlight: () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mantine/spotlight",
-  "version": "7.13.5-alpha.0",
+  "version": "7.13.5-alpha.2",
   "description": "Command center components for react and Mantine",
   "homepage": "https://mantine.dev",
   "license": "MIT",
@@ -41,13 +41,13 @@
     "directory": "packages/@mantine/spotlight"
   },
   "peerDependencies": {
-    "@mantine/core": "7.13.5-alpha.0",
-    "@mantine/hooks": "7.13.5-alpha.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "@mantine/core": "7.13.5-alpha.2",
+    "@mantine/hooks": "7.13.5-alpha.2",
+    "react": "^18.x || ^19.x",
+    "react-dom": "^18.x || ^19.x"
   },
   "dependencies": {
-    "@mantine/store": "7.13.5-alpha.0"
+    "@mantine/store": "7.13.5-alpha.2"
   },
   "devDependencies": {
     "@mantine-tests/core": "workspace:*",