@neo4j-ndl/react 3.1.7 → 3.2.1

package/lib/types/spotlight/Spotlight.d.ts

@@ -0,0 +1,84 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import React from 'react';
+import { HtmlAttributes, PolymorphicForwardRefExoticComponent, PolymorphicPropsWithRef } from '../_common/types';
+import { EventTypeLabelProps } from '../label';
+export type SpotlightActionsProps = {
+    label: string;
+    isDisabled?: boolean;
+    fill?: 'text' | 'outlined';
+} & ({
+    as: 'button';
+    onClick?: (event: React.MouseEvent<HTMLButtonElement>) => void;
+} | {
+    as?: 'a';
+    href?: string;
+    target?: React.ComponentPropsWithoutRef<'a'>['target'];
+} | {
+    as: React.ElementType;
+});
+declare const SpotlightActions: PolymorphicForwardRefExoticComponent<'button', SpotlightActionsProps>;
+type SpotlightHeaderProps = {
+    children?: React.ReactNode;
+};
+type SpotlightBodyProps = {
+    children?: React.ReactNode;
+};
+type SpotlightLabelProps = Omit<EventTypeLabelProps, 'color' | 'fill'>;
+type SpotlightImageProps = {
+    src: string;
+    alt: string;
+    htmlAttributes?: HtmlAttributes<'img'>;
+    className?: string;
+    style?: React.CSSProperties;
+};
+type SpotlightIconWrapperProps = {
+    children?: React.ReactNode;
+};
+export type SpotlightCloseAction = 'clickOutside' | 'escapeKeyDown';
+export type SpotlightProps = {
+    /** Id of the SpotlightTarget where the spotlight should be rendered */
+    target: string;
+    /** Action buttons in the footer */
+    actions?: React.ComponentProps<typeof SpotlightActions>[];
+    /** Left bottom corner content */
+    beforeActions?: React.ReactNode;
+    /** Which element to initially focus. Either a tabbable index or ref */
+    initialFocus?: number | React.MutableRefObject<HTMLElement | null>;
+    onClose?: (action: SpotlightCloseAction) => void;
+    children?: React.ReactNode;
+    className?: string;
+    style?: React.CSSProperties;
+    htmlAttributes?: HtmlAttributes<'div'>;
+};
+declare const Spotlight: Omit<React.ForwardRefExoticComponent<SpotlightProps & {
+    [key: string]: unknown;
+}>, "$$typeof"> & Omit<React.ExoticComponent<SpotlightProps & {
+    [key: string]: unknown;
+}>, never> & (<InstanceT extends React.ElementType = "div">(props: PolymorphicPropsWithRef<InstanceT, SpotlightProps>) => React.ReactElement | null) & {
+    Actions: PolymorphicForwardRefExoticComponent<"button", SpotlightActionsProps>;
+    Body: PolymorphicForwardRefExoticComponent<"div", SpotlightBodyProps>;
+    Header: PolymorphicForwardRefExoticComponent<"div", SpotlightHeaderProps>;
+    IconWrapper: PolymorphicForwardRefExoticComponent<"div", SpotlightIconWrapperProps>;
+    Image: React.ForwardRefExoticComponent<SpotlightImageProps & React.RefAttributes<HTMLImageElement>>;
+    Label: PolymorphicForwardRefExoticComponent<"div", SpotlightLabelProps>;
+};
+export { Spotlight };

package/lib/types/spotlight/SpotlightProvider.d.ts

@@ -0,0 +1,40 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import React from 'react';
+type SpotlightContextType = {
+    /** Is true if the spotlight is open */
+    isOpen: boolean;
+    /** Closes or opens the spotlight */
+    setIsOpen: (arg: boolean) => void;
+    /** Is true if the provided target is the active spotlight */
+    isActiveSpotlight: (target: string) => boolean;
+    /** Sets the active spotlight to the provided target. Use null to clear active target */
+    setActiveSpotlight: (target: string | null) => void;
+};
+export declare const useSpotlightContext: () => SpotlightContextType;
+type SpotlightProviderProps = {
+    children: React.ReactNode;
+    /** If the spotlights should have an overlay */
+    hasOverlay?: boolean;
+};
+export declare const SpotlightProvider: (props: SpotlightProviderProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/types/spotlight/SpotlightTarget.d.ts

@@ -0,0 +1,37 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import React from 'react';
+import { PolymorphicForwardRefExoticComponent } from '../_common/types';
+type SpotlightTargetProps = {
+    /** id of the target. should match with target prop in Spotlight */
+    id: string;
+    /** if the target should have a pulse animation. default behaviour is true */
+    hasPulse?: boolean;
+    /** background color */
+    backgroundColor?: React.CSSProperties['backgroundColor'];
+    /** border radius */
+    borderRadius?: React.CSSProperties['borderRadius'];
+    /** classnames are only applied when target is active */
+    className?: string;
+    children?: React.ReactNode;
+};
+export declare const SpotlightTarget: PolymorphicForwardRefExoticComponent<'div', SpotlightTargetProps>;
+export {};

package/lib/types/spotlight/SpotlightTour.d.ts

@@ -0,0 +1,39 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import React from 'react';
+import { Spotlight, SpotlightCloseAction } from './Spotlight';
+type SpotlightTourAction = SpotlightCloseAction | 'dismiss' | 'back' | 'next' | 'close';
+type SpotlightTourProps = {
+    /** Array of spotlights */
+    spotlights: React.ComponentProps<typeof Spotlight>[];
+    /** Text override for dismiss button */
+    dismissButtonText?: string;
+    /** Text override for back button */
+    backButtonText?: string;
+    /** Text override for next button */
+    nextButtonText?: string;
+    /** Text override for close button */
+    closeButtonText?: string;
+    /** Callback function on button clicks, outside clicks, and escape key down  */
+    onAction?: (target: string, action: SpotlightTourAction) => void;
+};
+export declare const SpotlightTour: (props: SpotlightTourProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/types/spotlight/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ *
+ *  Copyright (c) "Neo4j"
+ *  Neo4j Sweden AB [http://neo4j.com]
+ *
+ *  This file is part of Neo4j.
+ *
+ *  Neo4j is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+export * from './Spotlight';
+export * from './SpotlightProvider';
+export * from './SpotlightTarget';
+export * from './SpotlightTour';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-ndl/react",
-  "version": "3.1.7",
+  "version": "3.2.1",
   "sideEffects": false,
   "description": "React implementation of Neo4j Design System",
   "keywords": [
@@ -64,7 +64,7 @@
     "@tanstack/react-table": "8.20.5",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "@neo4j-ndl/base": "^3.1.4"
+    "@neo4j-ndl/base": "^3.2.0"
   },
   "dependencies": {
     "@dnd-kit/core": "6.1.0",