@splunk/react-page 8.0.0 → 8.2.0-beta.1

package/Loading.d.ts

@@ -0,0 +1,19 @@
+export default Loading;
+declare function Loading({ AppBarFallback, hideAppBar, hideChrome, hideSplunkBar, SplunkBarFallback, }: {
+    AppBarFallback?: import("styled-components").StyledComponent<"div", any, {}, never>;
+    hideAppBar: any;
+    hideChrome: any;
+    hideSplunkBar: any;
+    SplunkBarFallback?: import("styled-components").StyledComponent<"div", any, {}, never>;
+}): import("react/jsx-runtime").JSX.Element;
+declare namespace Loading {
+    export { propTypes };
+}
+declare namespace propTypes {
+    let hideAppBar: PropTypes.Requireable<boolean>;
+    let hideChrome: PropTypes.Requireable<boolean>;
+    let hideSplunkBar: PropTypes.Requireable<boolean>;
+    let AppBarFallback: PropTypes.Requireable<PropTypes.ReactComponentLike>;
+    let SplunkBarFallback: PropTypes.Requireable<PropTypes.ReactComponentLike>;
+}
+import PropTypes from 'prop-types';

package/LoadingStyles.d.ts

@@ -0,0 +1,7 @@
+export const Main: import("styled-components").StyledComponent<"div", any, import("@splunk/themes").OptionalThemedProps<import("@splunk/themes").AnyTheme>, never>;
+export const SplunkBar: import("styled-components").StyledComponent<"div", any, {}, never>;
+export const AppBar: import("styled-components").StyledComponent<"div", any, {}, never>;
+export const AppBody: import("styled-components").StyledComponent<"div", any, import("@splunk/themes").OptionalThemedProps<import("@splunk/themes").AnyTheme>, never>;
+export const Dot: import("styled-components").StyledComponent<"div", any, {}, never>;
+export const APPBAR_HEIGHT: 45;
+export const SPLUNKBAR_HEIGHT: 34;

package/baseLayout.d.ts

@@ -0,0 +1,39 @@
+export default layout;
+/**
+ * Renders a React element into the Layout API.
+ * @public
+ * @param {element} element - A React element.
+ * @param {element} render - A render function that returns an unmount() function.
+ * @param {object} [options]
+ * @param {string} [options.pageTitle] - Changes the page title.
+ * @param {Boolean} [options.hideAppBar = false] - Hides the app bar.
+ * @param {Boolean} [options.hideAppsList = false] - Hides the app list in
+ * the Splunk bar.
+ * @param {Boolean} [options.hideChrome = false] - Renders only the main content, hiding
+ * the Splunk bar, app bar, and footer.
+ * @param {Boolean} [options.hideFooter = false] - Hides the footer.
+ * @param {Boolean} [options.hideSplunkBar = false] - Hides the Splunk bar.
+ * @param {string} [options.layout = 'scrolling'] - Set to `fixed` to fix all navigation bars
+ * to the edge of the page.
+ * @param {Boolean} [options.useGlobalLayerStack = true] - Wraps elements in @splunk/react-ui's LayerStackGlobalProvider.
+ * @private {Boolean} [options.navLayout = 'classic'] - Used to determine layout asset to load. Ex. "classic" or "auto".
+ * @param {String} [options.theme = 'light'] - Used to theme UI elements. Ex. "light" or "dark".
+ * @param {String} [options.themeFamily = 'enterprise'] - Ex. Theme family to use for UI elements. Ex. "enterprise" or "prisma".
+ * @param {String} [options.themeDensity] - Ex. Theme density to use for UI elements. Ex. "compact" or "comfortable".
+ * @param {String} [options.loader = 'scriptjs'] - Configures the loader used for the loading the layout - available loaders are "scriptjs" and "requirejs".
+ * Change this only if the default loader does not work for your application.
+ * @param {Boolean} [options.lazyLoadLayout = false] - Prioritizes loading the React element and lazily fetches and compiles the layout API (navigation bar).
+ * @param {element} [options.SplunkBarFallback = SplunkBar] - A React element used as a placeholder for the splunk bar while the navigation bar is loading.
+ * @param {element} [options.AppBarFallback = AppBar] - A React element used as a placeholder for the app bar while the navigation bar is loading.
+ * @param {function} [options.onLayoutComplete] - A callback function which executes after layout API is fetched and compiled.
+ */
+declare function layout(element: any, render: any, { useGlobalLayerStack, pageTitle, theme, themeDensity, loader, ...layoutAPIOptions }?: {
+    pageTitle?: string;
+    hideAppBar?: boolean;
+    hideAppsList?: boolean;
+    hideChrome?: boolean;
+    hideFooter?: boolean;
+    hideSplunkBar?: boolean;
+    layout?: string;
+    useGlobalLayerStack?: boolean;
+}): void;

package/index.d.ts

@@ -0,0 +1,50 @@
+export default layout;
+/**
+ * Renders a React element into the Layout API.
+ * @public
+ * @param {element} element - A React element.
+ * @param {object} [options]
+ * @param {string} [options.pageTitle] - Changes the page title.
+ * @param {Boolean} [options.hideAppBar = false] - Hides the app bar.
+ * @param {Boolean} [options.hideAppsList = false] - Hides the app list in
+ * the Splunk bar.
+ * @param {Boolean} [options.hideChrome = false] - Renders only the main content, hiding
+ * the Splunk bar, app bar, and footer.
+ * @param {Boolean} [options.hideFooter = false] - Hides the footer.
+ * @param {Boolean} [options.hideSplunkBar = false] - Hides the Splunk bar.
+ * @param {string} [options.layout = 'scrolling'] - Set to `fixed` to fix all navigation bars
+ * to the edge of the page.
+ * @param {Boolean} [options.useGlobalLayerStack = true] - Wraps elements in `@splunk/react-ui`'s LayerStackGlobalProvider.
+ * @param {String} [options.theme = 'light'] - Used to theme UI elements. Ex. "light" or "dark".
+ * @param {String} [options.themeFamily = 'enterprise'] - Ex. Theme family to use for UI elements. Ex. "enterprise" or "prisma".
+ * @param {String} [options.themeDensity] - Ex. Theme density to use for UI elements. Ex. "compact" or "comfortable".
+ * @param {String} [options.loader = 'scriptjs'] - Configures the loader used for the loading the layout - available loaders are "scriptjs" and "requirejs".
+ * Change this only if the default loader does not work for your application.
+ * @param {Boolean} [options.lazyLoadLayout = false] - Prioritizes loading the React element and lazily fetches and compiles the layout API (navigation bar).
+ * @param {element} [options.SplunkBarFallback = SplunkBar] - A React element used as a placeholder for the splunk bar while the navigation bar is loading.
+ * @param {element} [options.AppBarFallback = AppBar] - A React element used as a placeholder for the app bar while the navigation bar is loading.
+ * @param {function} [options.onLayoutComplete] - A callback function which executes after layout API is fetched and compiled.
+ * @param {function} [options.onLayoutStart] - A callback function which executes once the layout starts to render
+ */
+declare function layout(element: any, options?: {
+    pageTitle?: string;
+    hideAppBar?: boolean;
+    hideAppsList?: boolean;
+    hideChrome?: boolean;
+    hideFooter?: boolean;
+    hideSplunkBar?: boolean;
+    layout?: string;
+    useGlobalLayerStack?: boolean;
+    theme?: string;
+    themeFamily?: string;
+    themeDensity?: string;
+    loader?: string;
+    lazyLoadLayout?: boolean;
+    SplunkBarFallback?: any;
+    AppBarFallback?: any;
+    onLayoutComplete?: Function;
+    onLayoutStart?: Function;
+}): void;
+import { AppBar } from './LoadingStyles';
+import { SplunkBar } from './LoadingStyles';
+export { AppBar, SplunkBar };