@pantheon-systems/pds-toolkit-react 1.0.0-dev.171 → 1.0.0-dev.172

package/_dist/layouts/Container/Container.d.ts

@@ -1,16 +1,25 @@
-export function Container({ children, width, className, ...props }: {
-    [x: string]: any;
-    children: any;
-    width?: string;
-    className: any;
-}): React.JSX.Element;
-export namespace Container {
-    namespace propTypes {
-        export let children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        export { ContainerWidth as width };
-        export let className: PropTypes.Requireable<string>;
-    }
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import { ContainerWidth } from '@libs/types/custom-types';
+import '../../utilities/container.css';
+/**
+ * Prop types for Container
+ */
+interface ContainerProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Container content.
+     */
+    children?: ReactNode;
+    /**
+     * Width of the container.
+     */
+    width?: ContainerWidth;
+    /**
+     * Additional class names
+     */
+    className?: string;
 }
-import React from 'react';
-import PropTypes from 'prop-types';
-import { ContainerWidth } from '@libs/components/customPropTypes';
+/**
+ * Container UI component
+ */
+export declare const Container: ({ children, width, className, ...props }: ContainerProps) => React.JSX.Element;
+export {};

package/_dist/layouts/DashboardLayout/DashboardLayout.d.ts

@@ -1,4 +1,4 @@
-import React, { ComponentPropsWithoutRef } from 'react';
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
 export declare const DashboardContext: React.Context<any>;
 import './dashboard-layout.css';
 /**
@@ -6,39 +6,43 @@ import './dashboard-layout.css';
  */
 export interface DashboardLayoutProps extends ComponentPropsWithoutRef<'div'> {
     /**
-     * Child components
+     * Child elements to be assigned to named slots.
      */
-    children: React.ReactNode;
+    children: ReactNode;
     /**
-     * Whether to include a sidebar toggle button
+     * Whether to include a sidebar toggle button.
      */
     hasSidebarToggle?: boolean;
     /**
-     * Whether the sidebar is initially expanded
+     * Whether the sidebar should be expanded by default.
      */
     initialSidebarExpanded?: boolean;
     /**
-     * Width of the sidebar when collapsed in rems
+     * A fully-formed link element using the router of your choice. The link text will be used as the aria-label. If the logo should not be a link, set to `null`.
+     */
+    logoLinkContent?: ReactNode;
+    /**
+     * Width of the sidebar when collapsed in rems. This should not need to be modified.
      */
     sidebarCollapsedWidth?: number;
     /**
-     * Width of the sidebar when expanded in rems
+     * Width of the sidebar when expanded in rems. This should not need to be modified, unless slightly to accommodate longer top-level navigation items.
      */
     sidebarExpandedWidth?: number;
     /**
-     * Sidebar toggle label
+     * Translatable string for sidebar toggle button.
      */
     sidebarToggleLabel?: string;
     /**
-     * Skip link text
+     * Translatable string for skiplink.
      */
     skiplinkText?: string;
     /**
-     * Additional class names
+     * Additional class names. Will be merged with existing component root classes.
      */
     className?: string;
 }
 /**
  * DashboardLayout UI component
  */
-export declare const DashboardLayout: ({ children, hasSidebarToggle, initialSidebarExpanded, sidebarCollapsedWidth, sidebarExpandedWidth, sidebarToggleLabel, skiplinkText, className, ...props }: DashboardLayoutProps) => React.JSX.Element;
+export declare const DashboardLayout: ({ children, hasSidebarToggle, initialSidebarExpanded, logoLinkContent, sidebarCollapsedWidth, sidebarExpandedWidth, sidebarToggleLabel, skiplinkText, className, ...props }: DashboardLayoutProps) => React.JSX.Element;

package/_dist/libs/components/utils.d.ts

@@ -1,3 +1,4 @@
-export declare const createRandomID: () => string;
-export declare const getDescendants: (node: any, collect: any) => any;
-export declare const mergeClasses: (styles: any) => any;
+export function createRandomID(): string;
+export function getDescendants(node: any, collect: any): any;
+export function mergeClasses(styles: any): any;
+export function initiateSlots(children: any): {};

package/_dist/libs/types/custom-types.d.ts

@@ -0,0 +1,10 @@
+export type ButtonDisplayType = 'label-only' | 'icon-start' | 'icon-end';
+export type ButtonSize = 'sm' | 'md' | 'lg';
+export type ButtonType = 'button' | 'submit' | 'reset';
+export type ButtonVariant = 'primary' | 'secondary' | 'subtle' | 'brand' | 'brand-secondary' | 'critical' | 'navbar' | 'inline';
+export type ContainerWidth = 'narrow' | 'standard' | 'wide' | 'x-wide' | 'full';
+export type FuiOffset = number | {
+    mainAxis?: number;
+    crossAxis?: number;
+    alignmentAxis?: number | null;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@pantheon-systems/pds-toolkit-react",
 	"technology": "React",
-	"version": "1.0.0-dev.171",
+	"version": "1.0.0-dev.172",
 	"description": "PDS toolkit built using the React framework",
 	"repository": {
 		"type": "git",

package/_dist/libs/components/custom-types.d.ts

@@ -1,5 +0,0 @@
-export type FuiOffset = number | {
-    mainAxis?: number;
-    crossAxis?: number;
-    alignmentAxis?: number | null;
-};