blue-react 8.3.1 → 8.3.2

package/dist/types/components/HeaderTitle.d.ts

@@ -1,29 +1,29 @@
-/// <reference types="react" />
-export interface HeaderTitleProps {
-    /**
-     * Can be an image. Will be placed inside of the `src` attribute.
-     */
-    logo?: string;
-    /**
-     * Text next to the logo.
-     */
-    appTitle?: string;
-    /**
-     * Disables that the app title will disappear at a specific view width.
-     */
-    keepAppTitle?: boolean;
-    children?: any;
-    /**
-     * Extends `className` from parent element.
-     */
-    className?: string;
-    /**
-     * Is the component used on the sidebar?
-     */
-    sidebar?: boolean;
-}
-/**
- * The title area at the header bar.
- * Depending on its content, the document's title will be set aswell (what will be shown in the browser title bar).
- */
-export default function HeaderTitle({ logo, appTitle, keepAppTitle, children, className, sidebar }: HeaderTitleProps): JSX.Element;
+/// <reference types="react" />
+export interface HeaderTitleProps {
+    /**
+     * Can be an image. Will be placed inside of the `src` attribute.
+     */
+    logo?: string;
+    /**
+     * Text next to the logo.
+     */
+    appTitle?: string;
+    /**
+     * Disables that the app title will disappear at a specific view width.
+     */
+    keepAppTitle?: boolean;
+    children?: any;
+    /**
+     * Extends `className` from parent element.
+     */
+    className?: string;
+    /**
+     * Is the component used on the sidebar?
+     */
+    sidebar?: boolean;
+}
+/**
+ * The title area at the header bar.
+ * Depending on its content, the document's title will be set aswell (what will be shown in the browser title bar).
+ */
+export default function HeaderTitle({ logo, appTitle, keepAppTitle, children, className, sidebar }: HeaderTitleProps): JSX.Element;

package/dist/types/components/Intro.d.ts

@@ -1,23 +1,23 @@
-/// <reference types="react" />
-export interface IntroProps {
-    /**
-     * Can be an image. Will be placed inside of the `src` attribute.
-     */
-    logo?: string;
-    /**
-     * Max width from the logo.
-     */
-    logoMaxWidth?: string;
-    /**
-     * Text which will be placed under the logo.
-     */
-    title?: string;
-    /**
-     * Content
-     */
-    children?: any;
-}
-/**
- * Can be used for a sign-in page.
- */
-export default function Intro({ logo, logoMaxWidth, title, children }: IntroProps): JSX.Element;
+/// <reference types="react" />
+export interface IntroProps {
+    /**
+     * Can be an image. Will be placed inside of the `src` attribute.
+     */
+    logo?: string;
+    /**
+     * Max width from the logo.
+     */
+    logoMaxWidth?: string;
+    /**
+     * Text which will be placed under the logo.
+     */
+    title?: string;
+    /**
+     * Content
+     */
+    children?: any;
+}
+/**
+ * Can be used for a sign-in page.
+ */
+export default function Intro({ logo, logoMaxWidth, title, children }: IntroProps): JSX.Element;

package/dist/types/components/Layout.d.ts

@@ -1,120 +1,120 @@
-import { Component, CSSProperties } from "react";
-declare global {
-    interface Window {
-        blueLayoutRef: any;
-        toggleSidebarEvent: any;
-    }
-}
-export interface LayoutProps {
-    id?: string;
-    sidebarIn?: boolean;
-    style?: CSSProperties;
-    /**
-     * Sidebar is automatically expanded on wider views.
-     */
-    expandSidebar?: boolean;
-    /**
-     * Disables sidebar.
-     */
-    hideSidebarMenu?: boolean;
-    /**
-     * Registers pages for the built-in routing system. Example: `[{name: "home", component: <HomePage />}]`
-     */
-    pages?: {
-        name: string;
-        component: JSX.Element;
-    }[];
-    /**
-     * When `true`, always the "home" route will be rendered.
-     */
-    unrouteable?: boolean;
-    /**
-     * Extends `className`.
-     */
-    className?: string;
-    /**
-     * By default, the document title will automatically set. Set this prop to `true` to disable this behaviour.
-     */
-    disableTitleSet?: boolean;
-    /**
-     * If you don't use blueicon, you can define another icon element for the sidebar toggle button.
-     */
-    sidebarToggleIconComponent?: any;
-    /**
-     * Will replace status icons with custom ones. This will also overwrite the `useBlueicons` option.
-     * This can be a SVG component or a normal element component.
-     */
-    statusIcons?: {
-        danger: any;
-        info: any;
-        success: any;
-        warning: any;
-    };
-    /**
-     * Disables the header bars on pages.
-     */
-    disableHeaders?: boolean;
-    /**
-     * Define a function, that will be fired when switching routes. When your function returns `true`, the default route behaviour will be blocked.
-     * You can use something like `window.blueLayoutRef.setState({ blockRouting: onHashChange })` globally to set the value from anywhere in your app.
-     */
-    blockRouting?: (newMatch: string[], currentMatch: string[]) => void | boolean;
-    children?: any;
-}
-export interface LayoutState {
-    sidebarIn?: boolean;
-    match: any;
-    history: string[];
-    hash: string;
-    hashHistory: string[];
-    blockRouting?: (newMatch: string[], currentMatch: string[]) => void | boolean;
-}
-/**
- * The main component. As soon this component is mounted, it is globally available under `window.blueLayoutRef`.
- * You can also append your own event listeners.
- *
- * Allowed events:
- *
- * * **componentDidUpdate** - Component was updated.
- *   Example: `window.blueLayoutRef.addEventListener("componentDidUpdate", (prevProps, prevState) => { })`
- * * **pageDidShowAgain** - Page appeared again with the same old state. In the callback function you can reinitialize things.
- *   Example: `window.blueLayoutRef.addEventListener("pageDidShowAgain", "home", (prevProps, prevState) => { })`
- * * **pageDidHide** - This page disappeared and another page appears instead.
- *   Example: `window.blueLayoutRef.addEventListener("pageDidHide", "home", (prevProps, prevState) => { })`
- *
- * Method to add event listeners:
- * * `window.blueLayoutRef.`**addEventListener**`(eventName: string, param2: any, param3: any, listenerId?: string)`
- *
- * Methods to remove event listeners:
- * * `window.blueLayoutRef.`**removeEventListener**`(eventName: string, listenerId: string)`
- * * `window.blueLayoutRef.`**removeDuplicatedEventListeners**`()` - Will automatically be called when running `addEventListener`
- */
-export default class Layout extends Component<LayoutProps, LayoutState> {
-    defaultMatch: string[];
-    eventListeners: any[];
-    constructor(props: LayoutProps);
-    onHashChange(): void;
-    static get defaultProps(): {
-        expandSidebar: boolean;
-        hideSidebarMenu: boolean;
-        unrouteable: boolean;
-        disableTitleSet: boolean;
-        sidebarToggleIconComponent: JSX.Element;
-        statusIcons: {
-            danger: JSX.Element;
-            info: JSX.Element;
-            success: JSX.Element;
-            warning: JSX.Element;
-        };
-    };
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    componentDidUpdate(prevProps: LayoutProps, prevState: LayoutState): void;
-    toggleSidebar(event: any): void;
-    hideSidebar(e: any): void;
-    initMatch(): void;
-    addEventListener(param1: any, param2: any, param3: any, listenerId?: string): void;
-    removeEventListener(type: string, listenerId: string): void;
-    removeDuplicatedEventListeners(): void;
-    render(): JSX.Element;
-}
+import { Component, CSSProperties } from "react";
+declare global {
+    interface Window {
+        blueLayoutRef: any;
+        toggleSidebarEvent: any;
+    }
+}
+export interface LayoutProps {
+    id?: string;
+    sidebarIn?: boolean;
+    style?: CSSProperties;
+    /**
+     * Sidebar is automatically expanded on wider views.
+     */
+    expandSidebar?: boolean;
+    /**
+     * Disables sidebar.
+     */
+    hideSidebarMenu?: boolean;
+    /**
+     * Registers pages for the built-in routing system. Example: `[{name: "home", component: <HomePage />}]`
+     */
+    pages?: {
+        name: string;
+        component: JSX.Element;
+    }[];
+    /**
+     * When `true`, always the "home" route will be rendered.
+     */
+    unrouteable?: boolean;
+    /**
+     * Extends `className`.
+     */
+    className?: string;
+    /**
+     * By default, the document title will automatically set. Set this prop to `true` to disable this behaviour.
+     */
+    disableTitleSet?: boolean;
+    /**
+     * If you don't use blueicon, you can define another icon element for the sidebar toggle button.
+     */
+    sidebarToggleIconComponent?: any;
+    /**
+     * Will replace status icons with custom ones. This will also overwrite the `useBlueicons` option.
+     * This can be a SVG component or a normal element component.
+     */
+    statusIcons?: {
+        danger: any;
+        info: any;
+        success: any;
+        warning: any;
+    };
+    /**
+     * Disables the header bars on pages.
+     */
+    disableHeaders?: boolean;
+    /**
+     * Define a function, that will be fired when switching routes. When your function returns `true`, the default route behaviour will be blocked.
+     * You can use something like `window.blueLayoutRef.setState({ blockRouting: onHashChange })` globally to set the value from anywhere in your app.
+     */
+    blockRouting?: (newMatch: string[], currentMatch: string[]) => void | boolean;
+    children?: any;
+}
+export interface LayoutState {
+    sidebarIn?: boolean;
+    match: any;
+    history: string[];
+    hash: string;
+    hashHistory: string[];
+    blockRouting?: (newMatch: string[], currentMatch: string[]) => void | boolean;
+}
+/**
+ * The main component. As soon this component is mounted, it is globally available under `window.blueLayoutRef`.
+ * You can also append your own event listeners.
+ *
+ * Allowed events:
+ *
+ * * **componentDidUpdate** - Component was updated.
+ *   Example: `window.blueLayoutRef.addEventListener("componentDidUpdate", (prevProps, prevState) => { })`
+ * * **pageDidShowAgain** - Page appeared again with the same old state. In the callback function you can reinitialize things.
+ *   Example: `window.blueLayoutRef.addEventListener("pageDidShowAgain", "home", (prevProps, prevState) => { })`
+ * * **pageDidHide** - This page disappeared and another page appears instead.
+ *   Example: `window.blueLayoutRef.addEventListener("pageDidHide", "home", (prevProps, prevState) => { })`
+ *
+ * Method to add event listeners:
+ * * `window.blueLayoutRef.`**addEventListener**`(eventName: string, param2: any, param3: any, listenerId?: string)`
+ *
+ * Methods to remove event listeners:
+ * * `window.blueLayoutRef.`**removeEventListener**`(eventName: string, listenerId: string)`
+ * * `window.blueLayoutRef.`**removeDuplicatedEventListeners**`()` - Will automatically be called when running `addEventListener`
+ */
+export default class Layout extends Component<LayoutProps, LayoutState> {
+    defaultMatch: string[];
+    eventListeners: any[];
+    constructor(props: LayoutProps);
+    onHashChange(): void;
+    static get defaultProps(): {
+        expandSidebar: boolean;
+        hideSidebarMenu: boolean;
+        unrouteable: boolean;
+        disableTitleSet: boolean;
+        sidebarToggleIconComponent: JSX.Element;
+        statusIcons: {
+            danger: JSX.Element;
+            info: JSX.Element;
+            success: JSX.Element;
+            warning: JSX.Element;
+        };
+    };
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    componentDidUpdate(prevProps: LayoutProps, prevState: LayoutState): void;
+    toggleSidebar(event: any): void;
+    hideSidebar(e: any): void;
+    initMatch(): void;
+    addEventListener(param1: any, param2: any, param3: any, listenerId?: string): void;
+    removeEventListener(type: string, listenerId: string): void;
+    removeDuplicatedEventListeners(): void;
+    render(): JSX.Element;
+}

package/dist/types/components/MenuItem.d.ts

@@ -1,69 +1,69 @@
-import React from "react";
-export interface MenuItemProps {
-    /**
-     * Sets `to` prop, e.g. when you use the `NavLink` component from React Router.
-     */
-    to?: string;
-    /**
-     * Prop for components by React Router.
-     */
-    exact?: boolean;
-    href?: string;
-    onClick?: (event: React.MouseEvent) => void;
-    /**
-     * Will be fired after `onClick`
-     */
-    onClickAttached?: (event: React.MouseEvent) => void;
-    /**
-     * Icon component or a class name.
-     */
-    icon?: any;
-    /**
-     * Icon component or a class name when the MenuItem is active.
-     */
-    iconForActive?: any;
-    /**
-     * Label of the link.
-     */
-    label?: any;
-    /**
-     * Should be set as active.
-     */
-    isActive?: boolean;
-    /**
-     * When using Blue React's routing system: define this link as home page link.
-     */
-    isHome?: boolean;
-    /**
-     * Extends class name of the dropdown menu.
-     */
-    dropdownClassName?: string;
-    /**
-     * Set children to create a nested `MenuItem` as a dropdown.
-     */
-    children?: any;
-    /**
-     * Defines class name.
-     */
-    className?: any;
-    /**
-     * Defines dropdown status from outside.
-     */
-    showDropdown?: boolean;
-    /**
-     * Close on click outside.
-     */
-    supportOutside?: boolean;
-    /**
-     * By default, MenuItem is a `"button"</button>. If you set a `href`, it's a `"a"`.
-     * If you want to have it another type, you can pass a component reference with this prop (e.g. `Link`).
-     */
-    elementType?: any;
-    target?: string;
-    rel?: string;
-    title?: string;
-}
-/**
- * Link, button or custom component for Sidebar, Actions or ActionMenu
- */
-export default function MenuItem(props: MenuItemProps): JSX.Element;
+import React from "react";
+export interface MenuItemProps {
+    /**
+     * Sets `to` prop, e.g. when you use the `NavLink` component from React Router.
+     */
+    to?: string;
+    /**
+     * Prop for components by React Router.
+     */
+    exact?: boolean;
+    href?: string;
+    onClick?: (event: React.MouseEvent) => void;
+    /**
+     * Will be fired after `onClick`
+     */
+    onClickAttached?: (event: React.MouseEvent) => void;
+    /**
+     * Icon component or a class name.
+     */
+    icon?: any;
+    /**
+     * Icon component or a class name when the MenuItem is active.
+     */
+    iconForActive?: any;
+    /**
+     * Label of the link.
+     */
+    label?: any;
+    /**
+     * Should be set as active.
+     */
+    isActive?: boolean;
+    /**
+     * When using Blue React's routing system: define this link as home page link.
+     */
+    isHome?: boolean;
+    /**
+     * Extends class name of the dropdown menu.
+     */
+    dropdownClassName?: string;
+    /**
+     * Set children to create a nested `MenuItem` as a dropdown.
+     */
+    children?: any;
+    /**
+     * Defines class name.
+     */
+    className?: any;
+    /**
+     * Defines dropdown status from outside.
+     */
+    showDropdown?: boolean;
+    /**
+     * Close on click outside.
+     */
+    supportOutside?: boolean;
+    /**
+     * By default, MenuItem is a `"button"</button>. If you set a `href`, it's a `"a"`.
+     * If you want to have it another type, you can pass a component reference with this prop (e.g. `Link`).
+     */
+    elementType?: any;
+    target?: string;
+    rel?: string;
+    title?: string;
+}
+/**
+ * Link, button or custom component for Sidebar, Actions or ActionMenu
+ */
+export default function MenuItem(props: MenuItemProps): JSX.Element;

package/dist/types/components/Modal.d.ts

@@ -1,25 +1,25 @@
-/// <reference types="react" />
-import { ModalType } from "./shared";
-export interface ModalProps {
-    modalContent?: string;
-    modalTitle?: string;
-    unSetModalContent: (modalContent?: string) => void;
-    /**
-     * Type of `input` depends on `type` prop and which action occured.
-     * When it's a string, the user entered something. When it's a boolean, the user clicked "Yes" or "No".
-     * When it's `null`, the user cancelled the modal.
-     */
-    onSubmit?: (input: string | boolean | null) => void;
-    defaultInput?: string;
-    /**
-     * `"ask"` | `"tell"` | `"verify"`
-     */
-    type: ModalType;
-}
-/**
- * Simple modal/dialog. Designed to work as an alternative to JavaScript's native `alert()`, `prompt()` and `confirm()` functions.
- * It uses Bootstrap's Modal components.
- *
- * For easy use, you should use the hook `useModal` together with `ModalProvider`. See the example there.
- */
-export default function Modal({ modalContent, modalTitle, unSetModalContent, onSubmit, defaultInput, type }: ModalProps): JSX.Element;
+/// <reference types="react" />
+import { ModalType } from "./shared";
+export interface ModalProps {
+    modalContent?: string;
+    modalTitle?: string;
+    unSetModalContent: (modalContent?: string) => void;
+    /**
+     * Type of `input` depends on `type` prop and which action occured.
+     * When it's a string, the user entered something. When it's a boolean, the user clicked "Yes" or "No".
+     * When it's `null`, the user cancelled the modal.
+     */
+    onSubmit?: (input: string | boolean | null) => void;
+    defaultInput?: string;
+    /**
+     * `"ask"` | `"tell"` | `"verify"`
+     */
+    type: ModalType;
+}
+/**
+ * Simple modal/dialog. Designed to work as an alternative to JavaScript's native `alert()`, `prompt()` and `confirm()` functions.
+ * It uses Bootstrap's Modal components.
+ *
+ * For easy use, you should use the hook `useModal` together with `ModalProvider`. See the example there.
+ */
+export default function Modal({ modalContent, modalTitle, unSetModalContent, onSubmit, defaultInput, type }: ModalProps): JSX.Element;

package/dist/types/components/ModalProvider.d.ts

@@ -1,11 +1,11 @@
-import { ReactNode } from "react";
-export interface ModalProviderProps {
-    children?: ReactNode;
-}
-declare const ModalProvider: ({ children, ...rest }: ModalProviderProps) => JSX.Element;
-declare const useModal: () => {
-    ask: (text: string, title?: string | undefined) => Promise<string | boolean>;
-    tell: (text: string, title?: string | undefined) => Promise<boolean>;
-    verify: (text: string, title?: string | undefined) => Promise<boolean>;
-};
-export { ModalProvider, useModal };
+import { ReactNode } from "react";
+export interface ModalProviderProps {
+    children?: ReactNode;
+}
+declare const ModalProvider: ({ children, ...rest }: ModalProviderProps) => JSX.Element;
+declare const useModal: () => {
+    ask: (text: string, title?: string | undefined) => Promise<string | boolean>;
+    tell: (text: string, title?: string | undefined) => Promise<boolean>;
+    verify: (text: string, title?: string | undefined) => Promise<boolean>;
+};
+export { ModalProvider, useModal };

package/dist/types/components/Outside.d.ts

@@ -1,14 +1,14 @@
-import { MutableRefObject } from "react";
-/**
- * Hook that alerts clicks outside of the passed ref
- */
-export declare function useOutside(ref: MutableRefObject<any>, callback?: (event: MouseEvent) => void): void;
-export interface OutsideProps {
-    children: any;
-    className?: string;
-    onClickOutside?: (event: MouseEvent) => void;
-}
-/**
- * Component that fires an event if you click outside of it
- */
-export default function Outside({ children, className, onClickOutside }: OutsideProps): JSX.Element;
+import { MutableRefObject } from "react";
+/**
+ * Hook that alerts clicks outside of the passed ref
+ */
+export declare function useOutside(ref: MutableRefObject<any>, callback?: (event: MouseEvent) => void): void;
+export interface OutsideProps {
+    children: any;
+    className?: string;
+    onClickOutside?: (event: MouseEvent) => void;
+}
+/**
+ * Component that fires an event if you click outside of it
+ */
+export default function Outside({ children, className, onClickOutside }: OutsideProps): JSX.Element;

package/dist/types/components/Page.d.ts

@@ -1,12 +1,12 @@
-/// <reference types="react" />
-export interface PageProps {
-    /**
-     * Will be set to the document's `<title>` tag.
-     */
-    title?: string;
-    children?: any;
-}
-/**
- * Main component for each page.
- */
-export default function Page({ children, title }: PageProps): JSX.Element;
+/// <reference types="react" />
+export interface PageProps {
+    /**
+     * Will be set to the document's `<title>` tag.
+     */
+    title?: string;
+    children?: any;
+}
+/**
+ * Main component for each page.
+ */
+export default function Page({ children, title }: PageProps): JSX.Element;