@pantheon-systems/pds-toolkit-react 1.0.0-dev.18 → 1.0.0-dev.180

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

@@ -0,0 +1,25 @@
+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;
+}
+/**
+ * Container UI component
+ */
+export declare const Container: ({ children, width, className, ...props }: ContainerProps) => React.JSX.Element;
+export {};

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

@@ -0,0 +1,52 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+export declare const DashboardContext: React.Context<any>;
+import './dashboard-layout.css';
+/**
+ * Prop types for DashboardLayout
+ */
+export interface DashboardLayoutProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Child elements to be assigned to named slots.
+     */
+    children: ReactNode;
+    /**
+     * Whether to include a sidebar toggle button.
+     */
+    hasSidebarToggle?: boolean;
+    /**
+     * Whether the sidebar should be expanded by default.
+     */
+    initialSidebarExpanded?: boolean;
+    /**
+     * 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. This should not need to be modified, unless slightly to accommodate longer top-level navigation items.
+     */
+    sidebarExpandedWidth?: number;
+    /**
+     * Translatable string for sidebar toggle button.
+     */
+    sidebarToggleLabel?: string;
+    /**
+     * Translatable string for skiplink.
+     */
+    skiplinkText?: string;
+    /**
+     * Additional class names. Will be merged with existing component root classes.
+     */
+    className?: string;
+    /**
+     * for admin view UI changes
+     */
+    isAdmin?: boolean;
+}
+/**
+ * DashboardLayout UI component
+ */
+export declare const DashboardLayout: ({ children, hasSidebarToggle, initialSidebarExpanded, isAdmin, logoLinkContent, sidebarCollapsedWidth, sidebarExpandedWidth, sidebarToggleLabel, skiplinkText, className, ...props }: DashboardLayoutProps) => React.JSX.Element;

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

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const DemoContent: () => React.JSX.Element;

package/_dist/layouts/FlexContainer/FlexContainer.d.ts

@@ -0,0 +1,27 @@
+export function FlexContainer({ alignContent, alignItems, flexDirection, flexWrap, justifyContent, mobileFlex, spacing, children, className, ...props }: {
+    [x: string]: any;
+    alignContent: any;
+    alignItems: any;
+    flexDirection: any;
+    flexWrap: any;
+    justifyContent: any;
+    mobileFlex?: string;
+    spacing?: string;
+    children: any;
+    className: any;
+}): React.JSX.Element;
+export namespace FlexContainer {
+    namespace propTypes {
+        let alignContent: PropTypes.Requireable<string>;
+        let alignItems: PropTypes.Requireable<string>;
+        let flexDirection: PropTypes.Requireable<string>;
+        let flexWrap: PropTypes.Requireable<string>;
+        let justifyContent: PropTypes.Requireable<string>;
+        let mobileFlex: PropTypes.Requireable<string>;
+        let spacing: PropTypes.Requireable<string>;
+        let children: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
+        let className: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

package/_dist/layouts/GlobalWrapper/GlobalWrapper.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+/**
+ * Prop types for GlobalWrapper
+ */
+interface GlobalWrapperProps {
+    /**
+     * Child components
+     */
+    children: React.ReactNode;
+    /**
+     *  Mobile menu will be enabled when viewport is at or below this number in pixels.
+     */
+    mobileMenuMaxWidth?: number;
+}
+/**
+ * GlobalWrapper wrapper component.
+ */
+export declare const GlobalWrapper: ({ children, mobileMenuMaxWidth, }: GlobalWrapperProps) => React.JSX.Element;
+export {};

package/_dist/layouts/SidebarLayout/SidebarLayout.d.ts

@@ -0,0 +1,36 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import { GridGapOptions } from '@layouts/layout-types';
+/**
+ * Prop types for SidebarLayout
+ */
+interface SidebarLayoutProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Children to render in the layout.
+     */
+    children: ReactNode;
+    /**
+     * Gap between grid items
+     */
+    gridGap?: GridGapOptions;
+    /**
+     * Sidebar location.
+     */
+    sidebarLocation?: 'left' | 'right';
+    /**
+     * Sidebar location on mobile.
+     */
+    sidebarMobileLocation?: 'before' | 'after';
+    /**
+     * Sidebar width.
+     */
+    sidebarWidth?: 'narrow' | 'standard' | 'wide';
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * SidebarLayout UI component
+ */
+export declare const SidebarLayout: ({ children, gridGap, sidebarLocation, sidebarMobileLocation, sidebarWidth, className, ...props }: SidebarLayoutProps) => React.JSX.Element;
+export {};

package/_dist/layouts/StepperLayout/StepperLayout.d.ts

@@ -0,0 +1,13 @@
+export function StepperLayout({ children, className, ...props }: {
+    [x: string]: any;
+    children: any;
+    className: any;
+}): React.JSX.Element;
+export namespace StepperLayout {
+    namespace propTypes {
+        let children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        let className: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

package/_dist/layouts/ThreeItemLayout/ThreeItemLayout.d.ts

@@ -0,0 +1,15 @@
+export function ThreeItemLayout({ children, gridGap, className, ...props }: {
+    [x: string]: any;
+    children: any;
+    gridGap?: string;
+    className: any;
+}): React.JSX.Element;
+export namespace ThreeItemLayout {
+    namespace propTypes {
+        let children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        let gridGap: PropTypes.Requireable<string>;
+        let className: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

package/_dist/layouts/TwoItemLayout/TwoItemLayout.d.ts

@@ -0,0 +1,17 @@
+export function TwoItemLayout({ children, gridGap, layoutVariant, className, ...props }: {
+    [x: string]: any;
+    children: any;
+    gridGap?: string;
+    layoutVariant?: string;
+    className: any;
+}): React.JSX.Element;
+export namespace TwoItemLayout {
+    namespace propTypes {
+        let children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        let gridGap: PropTypes.Requireable<string>;
+        let layoutVariant: PropTypes.Requireable<string>;
+        let className: PropTypes.Requireable<string>;
+    }
+}
+import React from 'react';
+import PropTypes from 'prop-types';

package/_dist/layouts/layout-types.d.ts

@@ -0,0 +1 @@
+export type GridGapOptions = 'narrow' | 'standard' | 'wide';

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

@@ -0,0 +1,85 @@
+export const PDSIcon: PropTypes.Requireable<string>;
+export const ContainerWidth: PropTypes.Requireable<string>;
+export const HeadingItemType: PropTypes.Requireable<Required<PropTypes.InferProps<{
+    /**
+     * Label for a menu item
+     */
+    label: PropTypes.Validator<string>;
+    /**
+     * Is the item a heading?
+     */
+    isHeading: PropTypes.Validator<boolean>;
+}>>>;
+export const LinkItemType: PropTypes.Requireable<Required<PropTypes.InferProps<{
+    /**
+     * Description of the item
+     */
+    description: PropTypes.Requireable<string>;
+    /**
+     *  Is this item disabled?
+     */
+    disabled: PropTypes.Requireable<boolean>;
+    /**
+     *  Optional icon for this item. Choose from available icons in the Icon component.
+     */
+    iconName: PropTypes.Requireable<string>;
+    /**
+     * Is the item a link?
+     */
+    isLink: PropTypes.Validator<boolean>;
+    /**
+     * The content of the link.
+     */
+    linkContent: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+    /**
+     *  Optional `data-testid` value for this item.
+     */
+    testId: PropTypes.Requireable<string>;
+}>>>;
+export const MenuItemType: PropTypes.Requireable<Required<PropTypes.InferProps<{
+    /**
+     * (optional) Callback function to execute when menu item is activated
+     */
+    callback: PropTypes.Requireable<(...args: any[]) => any>;
+    /**
+     * Description of the item
+     */
+    description: PropTypes.Requireable<string>;
+    /**
+     *  Is this item disabled?
+     */
+    disabled: PropTypes.Requireable<boolean>;
+    /**
+     *  Optional icon for this item. Choose from available icons in the Icon component.
+     */
+    iconName: PropTypes.Requireable<string>;
+    /**
+     * Optional ID value for this item.
+     */
+    id: PropTypes.Requireable<string>;
+    /**
+     * Label for a menu item
+     */
+    label: PropTypes.Validator<string>;
+    /**
+     *  Optional `data-testid` value for this item.
+     */
+    testId: PropTypes.Requireable<string>;
+}>>>;
+export const NodeItemType: PropTypes.Requireable<Required<PropTypes.InferProps<{
+    /**
+     * Is the item a node?
+     */
+    isNode: PropTypes.Validator<boolean>;
+    /**
+     * The content of the node.
+     */
+    nodeContent: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+}>>>;
+export const SeparatorItemType: PropTypes.Requireable<Required<PropTypes.InferProps<{
+    /**
+     * Is the item a separator?
+     */
+    isSeparator: PropTypes.Validator<boolean>;
+}>>>;
+import PropTypes from 'prop-types';

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

@@ -0,0 +1,4 @@
+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/_dist/utilities/context-providers/ResponsiveContext/ResponsiveContext.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export declare const ResponsiveContext: React.Context<any>;
+export declare const ResponsiveContextProvider: ({ children, mobileMenuMaxWidth, }: {
+    children: any;
+    mobileMenuMaxWidth?: number;
+}) => React.JSX.Element;

package/_dist/vars/spacing.d.ts

@@ -0,0 +1,17 @@
+export const SPACING_2XL: 1.953;
+export const SPACING_2XS: 0.512;
+export const SPACING_3XL: 2.441;
+export const SPACING_3XS: 0.41;
+export const SPACING_4XL: 3.052;
+export const SPACING_4XS: 0.328;
+export const SPACING_5XL: 3.815;
+export const SPACING_5XS: 0.25;
+export const SPACING_6XL: 4.678;
+export const SPACING_6XS: 0.125;
+export const SPACING_7XL: 5.96;
+export const SPACING_8XL: 7.451;
+export const SPACING_L: 1.25;
+export const SPACING_M: 1;
+export const SPACING_S: 0.8;
+export const SPACING_XL: 1.563;
+export const SPACING_XS: 0.64;

package/_dist/vars/z-index.d.ts

@@ -0,0 +1,5 @@
+export const Z_INDEX_NAVIGATION: 100;
+export const Z_INDEX_DROPDOWN: 200;
+export const Z_INDEX_NOTIFICATIONS: 300;
+export const Z_INDEX_OVERLAY: 400;
+export const Z_INDEX_MODAL: 500;

package/package.json

@@ -1,42 +1,65 @@
 {
 	"name": "@pantheon-systems/pds-toolkit-react",
 	"technology": "React",
-	"version": "1.0.0-dev.18",
+	"version": "1.0.0-dev.180",
 	"description": "PDS toolkit built using the React framework",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/pantheon-systems/pds-toolkit-react.git"
 	},
 	"author": "Pantheon Systems",
+	"engines": {
+		"node": ">=18.0.0 <=20.x"
+	},
 	"bugs": {
 		"url": "https://github.com/pantheon-systems/pds-toolkit-react/issues"
 	},
 	"homepage": "https://github.com/pantheon-systems/pds-toolkit-react#readme",
-	"main": "_dist/cjs/index.js",
-	"module": "_dist/esm/index.js",
+	"module": "_dist/index.js",
+	"types": "_dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./_dist/index.d.ts",
+			"import": "./_dist/index.js"
+		},
+		"./*": "./_dist/*"
+	},
 	"files": [
 		"_dist"
 	],
+	"sideEffects": [
+		"*.css"
+	],
+	"type": "module",
 	"scripts": {
-		"build": "rollup -c",
-		"postbuild": "npm run build:css && npm run build:css:components && npm run build:css:layouts",
+		"build": "npm run vite build && npm run build:types || true",
+		"build:types": "tsc -p tsconfig.build.json",
+		"prebuild": "vendor-copy",
+		"postbuild": "npm run build:css && npm run build:css:components && npm run build:css:layouts && npm run build:css:packageExtraCss",
 		"build:css": "postcss src/core.css -o _dist/css/pds-core.css",
 		"build:css:components": "postcss src/components/index.css -o _dist/css/pds-components.css",
 		"build:css:layouts": "postcss src/layouts/index.css -o _dist/css/pds-layouts.css",
+		"build:css:packageExtraCss": "node scripts/package-extra-css.js",
 		"build:css:watch": "npm run build:css -- -w",
+		"typecheck:tsc": "tsc --noEmit",
+		"typecheck:attw": "attw --pack . --ignore-rules cjs-resolves-to-esm no-resolution internal-resolution-error",
+		"typecheck:publint": "npx publint",
+		"typecheck": "npm run typecheck:attw && npm run typecheck:publint && npm run typecheck:tsc",
 		"prestorybook": "npm run build:css",
 		"storybook": "storybook dev -p 6006",
 		"prestorybook:build": "npm run build:css",
 		"storybook:build": "storybook build",
 		"develop": "concurrently --raw --kill-others \"npm run storybook\" \"npm run build:css:watch\"",
-		"eslint": "eslint --ext .jsx --ext .js",
-		"eslint:all": "eslint src --ext .jsx --ext .js --cache",
+		"predevelop": "vendor-copy",
+		"eslint": "eslint --ext .jsx,.tsx,.js,.ts",
+		"eslint:all": "eslint src --ext .jsx,.tsx,.js,.ts --cache",
+		"format:fix": "prettier . --write && npm run eslint:all -- --fix",
 		"pretest": "npm run build:css",
 		"test": "playwright test",
 		"pretest:vrt": "npm run build:css",
-		"test:vrt": "playwright test --project 'vrt:chromium' 'vrt:firefox' 'vrt:webkit' 'vrt:Mobile Chrome' 'vrt:Mobile Safari'",
-		"pretest:vrt:update-snapshots": "npm run build:css",
-		"test:vrt:update-snapshots": "npm run test:vrt -- --update-snapshots",
+		"test:vrt": "playwright test --project 'firefox' 'safari' 'iphone'",
+		"pretest:vrt:update": "npm run build:css",
+		"test:vrt:update": "npm run test:vrt -- --update-snapshots",
 		"pretest:a11y:generate": "npm run build:css",
 		"test:a11y:generate": "npm run storybook:build && npx sb extract && node __tests__/a11y/a11y.generate-tests.js",
 		"test:a11y": "playwright test --project 'a11y'",
@@ -48,72 +71,91 @@
 		"generate:foundation": "plop foundation",
 		"generate:pattern": "plop pattern",
 		"generate:utility": "plop utility",
-		"prepare": "husky install"
+		"prepare": "husky install",
+		"build-storybook": "storybook build",
+		"vite": "vite"
 	},
 	"devDependencies": {
+		"@arethetypeswrong/cli": "^0.15.3",
 		"@axe-core/playwright": "^4.7.0",
 		"@babel/preset-env": "^7.21.5",
 		"@babel/preset-react": "^7.18.6",
 		"@csstools/postcss-design-tokens": "^2.0.4",
 		"@csstools/postcss-global-data": "^1.0.3",
-		"@floating-ui/react-dom": "~1.3.0",
-		"@pantheon-systems/pds-design-tokens": "^1.0.0-dev.75",
 		"@playwright/test": "^1.36.2",
-		"@rollup/plugin-babel": "^6.0.3",
-		"@rollup/plugin-commonjs": "^24.1.0",
-		"@rollup/plugin-node-resolve": "^15.0.2",
-		"@storybook/addon-a11y": "^7.4.0",
-		"@storybook/addon-essentials": "^7.4.0",
-		"@storybook/addon-interactions": "^7.4.0",
-		"@storybook/addon-links": "^7.4.0",
-		"@storybook/addon-postcss": "^2.0.0",
-		"@storybook/addon-styling": "^1.3.7",
-		"@storybook/blocks": "^7.4.0",
-		"@storybook/manager-api": "^7.4.0",
-		"@storybook/react": "^7.4.0",
-		"@storybook/react-webpack5": "^7.4.0",
-		"@storybook/testing-library": "^0.2.0",
-		"@storybook/theming": "^7.4.0",
+		"@storybook/addon-a11y": "^8.2.4",
+		"@storybook/addon-essentials": "^8.2.4",
+		"@storybook/addon-interactions": "^8.2.4",
+		"@storybook/addon-links": "^8.2.4",
+		"@storybook/addon-webpack5-compiler-swc": "^1.0.2",
+		"@storybook/blocks": "^8.2.4",
+		"@storybook/react": "^8.2.4",
+		"@storybook/react-vite": "^8.2.4",
+		"@storybook/react-webpack5": "^8.2.4",
+		"@storybook/test": "^8.2.4",
+		"@storybook/theming": "^8.2.4",
+		"@typescript-eslint/eslint-plugin": "^7.7.0",
+		"@typescript-eslint/parser": "^7.7.0",
+		"@vitejs/plugin-react": "^4.3.0",
 		"axe-html-reporter": "^2.2.3",
 		"concurrently": "^8.0.1",
 		"cssnano": "^6.0.1",
-		"eslint": "^8.40.0",
-		"eslint-config-prettier": "^8.8.0",
+		"eslint": "^8.57.0",
+		"eslint-config-prettier": "^9.1.0",
+		"eslint-plugin-prettier": "^5.1.3",
 		"eslint-plugin-react": "^7.32.2",
-		"eslint-plugin-storybook": "^0.6.13",
+		"eslint-plugin-storybook": "^0.8.0",
+		"fast-glob": "^3.3.2",
 		"husky": "^8.0.3",
 		"lint-staged": "^13.2.3",
 		"plop": "^3.1.2",
-		"postcss": "^8.4.23",
+		"postcss": "^8.4.38",
 		"postcss-cli": "^10.1.0",
 		"postcss-custom-media": "^9.1.3",
 		"postcss-import": "^15.1.0",
 		"postcss-insert": "^1.0.0",
+		"postcss-loader": "^8.1.1",
 		"postcss-nested": "^6.0.1",
-		"prettier": "^2.8.8",
+		"prettier": "3.2.5",
+		"prettier-plugin-css-order": "^2.1.2",
 		"prop-types": "^15.8.1",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
-		"rollup": "^2.79.1",
-		"rollup-plugin-peer-deps-external": "^2.2.4",
-		"rollup-plugin-postcss": "^4.0.2",
-		"rollup-plugin-terser": "^7.0.2",
-		"storybook": "^7.4.0",
-		"storybook-dark-mode": "^3.0.1"
+		"storybook": "^8.2.4",
+		"storybook-dark-mode": "^4.0.1",
+		"typescript": "^5.4.5",
+		"vendor-copy": "^3.0.1",
+		"vite": "^5.2.11",
+		"vite-plugin-lib-inject-css": "^2.1.1",
+		"vite-tsconfig-paths": "^4.3.2"
 	},
 	"peerDependencies": {
 		"react": "^16.0.0 || ^17.0.0 || ^18.0.0"
 	},
 	"dependencies": {
 		"@floating-ui/react": "^0.24.3",
-		"@tippy.js/react": "^3.1.1",
+		"@floating-ui/react-dom": "~1.3.0",
+		"@pantheon-systems/pds-design-tokens": "^1.0.0-dev.140",
+		"@reactuses/core": "^5.0.15",
 		"focus-trap-react": "^10.2.1",
+		"hash-sum": "^2.0.0",
+		"react-hotkeys-hook": "^4.5.1",
 		"react-router-dom": "^6.13.0",
-		"tippy.js": "^6.3.7"
+		"react-toastify": "^9.0.3"
 	},
 	"lint-staged": {
-		"src/**/*.{js,jsx}": [
+		"src/**/*.{js,jsx,ts,tsx}": [
 			"npm run eslint"
 		]
-	}
+	},
+	"vendorCopy": [
+		{
+			"from": "node_modules/@pantheon-systems/pds-design-tokens/build/css/pds-design-tokens-dark-mode.css",
+			"to": "public/design-tokens/pds-design-tokens-dark-mode.css"
+		},
+		{
+			"from": "node_modules/@pantheon-systems/pds-design-tokens/build/css/pds-design-tokens-light-mode.css",
+			"to": "public/design-tokens/pds-design-tokens-light-mode.css"
+		}
+	]
 }