@pantheon-systems/pds-toolkit-react 1.0.0-dev.25 → 1.0.0-dev.251

package/README.md

@@ -1,7 +1,37 @@
 # pds-toolkit-react
 
-React Toolkit for the Pantheon Design System
+## React Toolkit for the Pantheon Design System
 
 This toolkit provides assets for use within a React project and a Storybook instance to preview the components.
 
 [Published Storybook](https://live-pds-toolkit-react.appa.pantheon.site/)
+
+## Toolkit philosophy and scope
+
+The intent of this toolkit is to provide a React-based implementation of the Pantheon Design System (PDS) with a focus on semantics, accessibility, visual design, and user-interface design.
+
+This toolkit should not contain processes or mechanisms used for data manipulation, business logic, or similar. Therefore, processes such as form handling, routing, and language translation should be handled within the application that is consuming the toolkit.
+
+Each component will contain a documentation page within Storybook that provides usage notes, implementation instructions, and expected data structure for that particular component.
+
+### Content within components
+
+Content should not live within components with a few exceptions — the Social Links component and the links in the legal section of the SiteFooter component. To maintain consistency between all of our digital properties, these links will originate from the design system.
+
+## Implementation instructions
+
+The toolkit consists of a global stylesheet and React components. Both are required for the toolkit to function as intended.
+
+The global stylesheet — `pds-core.css` — provides the base styles for the toolkit including foundations, utilities, and color variables. This stylesheet should be applied at the root of the application.
+
+The React components are imported and used within the application as needed. Component-specific styles are imported and applied automatically when the component is used.
+
+Components should be imported using named imports. For example:
+
+```js
+import { Container, SidebarLayout } from '@pantheon-systems/pds-toolkit-react';
+```
+
+### Avoid style conflicts
+
+This toolkit is not intended to be used in conjunction with other CSS frameworks. Doing so may result in unexpected behavior and/or visual conflicts.

package/_dist/components/Avatar/Avatar.d.ts

@@ -0,0 +1,36 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import './avatar.css';
+export interface AvatarProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Aria label for the avatar when used as a link. This is required if using a link.
+     */
+    ariaLabel?: string;
+    /**
+     * If true, a user icon will be displayed with the fallback gradient when an image is not provided.
+     */
+    hasUserFallback?: boolean;
+    /**
+     * Avatar image.
+     */
+    imageSrc?: string;
+    /**
+     * A link element using the router of your choice. Leave empty for no link.
+     */
+    linkContent?: ReactNode;
+    /**
+     * Avatar size.
+     */
+    size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+    /**
+     * Unique ID associated with the avatar. Can be workspace ID, user ID, email, etc.
+     */
+    uniqueId?: string;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * Avatar UI component
+ */
+export declare const Avatar: ({ ariaLabel, hasUserFallback, imageSrc, linkContent, size, uniqueId, className, ...props }: AvatarProps) => React.JSX.Element;

package/_dist/components/BranchDiff/BranchDiff.d.ts

@@ -0,0 +1,43 @@
+import React, { ComponentPropsWithoutRef } from 'react';
+import './branch-diff.css';
+/**
+ * Prop types for BranchDiff
+ */
+export interface BranchDiffProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Is the component in the process of loading?
+     */
+    isLoading?: boolean;
+    /**
+     * Text to be displayed in tooltip while component is loading.
+     */
+    loadingText?: string;
+    /**
+     * The number of commits the current branch is ahead of its upstream branch.
+     */
+    numberAhead: number;
+    /**
+     * A description for the `numberAhead` value.
+     */
+    numberAheadDescription?: string;
+    /**
+     * The number of commits the current branch is behind its upstream branch.
+     */
+    numberBehind: number;
+    /**
+     * A description for the `numberBehind` value.
+     */
+    numberBehindDescription?: string;
+    /**
+     * Custom width in rems for the component. This will override the default.
+     */
+    componentWidth?: number;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * BranchDiff UI component
+ */
+export declare const BranchDiff: ({ isLoading, loadingText, numberAhead, numberAheadDescription, numberBehind, numberBehindDescription, componentWidth, className, ...props }: BranchDiffProps) => React.JSX.Element;

package/_dist/components/CTALink/CTALink.d.ts

@@ -0,0 +1,20 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import './cta-link.css';
+export interface CTALinkProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * A link element using the router of your choice.
+     */
+    linkContent?: ReactNode;
+    /**
+     * Size of link
+     */
+    size?: 'sm' | 'md';
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * CTA Link UI component
+ */
+export declare const CTALink: ({ linkContent, size, className, ...props }: CTALinkProps) => React.JSX.Element;

package/_dist/components/CTASlice/CTASlice.d.ts

@@ -0,0 +1,43 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import { ContainerWidth, HeadingLevel } from '@libs/types/custom-types';
+import './../buttons/Button/button.css';
+import './cta-slice.css';
+interface CTASliceProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Background color of slice
+     */
+    backgroundColor?: 'default' | 'secondary';
+    /**
+     * PDS container width.
+     */
+    containerWidth?: ContainerWidth;
+    /**
+     *  Heading level
+     */
+    headingLevel?: HeadingLevel;
+    /**
+     * Heading text
+     */
+    headingText: string;
+    /**
+     * Further explain block
+     */
+    leadText?: string;
+    /**
+     * Primary link content
+     */
+    primaryLinkContent: ReactNode;
+    /**
+     * Optional secondary link content
+     */
+    secondaryLinkContent?: ReactNode;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * CTA Slice UI component
+ */
+export declare const CTASlice: ({ backgroundColor, containerWidth, headingLevel, headingText, leadText, primaryLinkContent, secondaryLinkContent, className, ...props }: CTASliceProps) => React.JSX.Element;
+export {};

package/_dist/components/Callout/Callout.d.ts

@@ -0,0 +1,31 @@
+import React, { ComponentPropsWithoutRef } from 'react';
+import './callout.css';
+type CalloutType = 'info' | 'success' | 'warning' | 'critical' | 'discovery' | 'code' | 'earlyAccess';
+type TypeLabels = Record<CalloutType, string>;
+export interface CalloutProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Callout main content.
+     */
+    children: React.ReactNode;
+    /**
+     * Callout title.
+     */
+    title: string;
+    /**
+     * Callout type.
+     */
+    type?: CalloutType;
+    /**
+     * Callout type labels. Provide translation strings if necessary.
+     */
+    typeLabels?: TypeLabels;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * Callout UI component
+ */
+export declare const Callout: ({ children, title, type, typeLabels, className, ...props }: CalloutProps) => React.JSX.Element;
+export {};

package/_dist/components/Callout/sample-callout-content.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const infoCalloutSample: React.JSX.Element;

package/_dist/components/CodeBlock/CodeBlock.d.ts

@@ -0,0 +1,61 @@
+import React, { ComponentPropsWithoutRef } from 'react';
+import 'prismjs/components/prism-bash';
+import 'prismjs/components/prism-diff';
+import './code-block.css';
+type SupportedLanguages = 'bash' | 'css' | 'diff' | 'html' | 'js' | 'json' | 'jsx' | 'ts' | 'tsx' | 'yaml';
+/**
+ * Prop types for CodeBlock
+ */
+export interface CodeBlockProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Code to display.
+     */
+    code: string;
+    /**
+     * Color type. Default is dark.
+     */
+    colorType?: 'dark' | 'light';
+    /**
+     * Copy button label. Aria-label and tooltip text for the copy button.
+     */
+    copyButtonLabel?: string;
+    /**
+     * Show copy button.
+     */
+    hasCopyButton?: boolean;
+    /**
+     * Show line numbers.
+     */
+    hasLineNumbers?: boolean;
+    /**
+     * Show prompt. A prompt and and line numbers cannot be shown at the same time.
+     * If both are set to true, line numbers will be shown.
+     */
+    hasPrompt?: boolean;
+    /**
+     * Language for optional syntax highlighting.
+     */
+    language?: SupportedLanguages;
+    /**
+     * Maximum height for the code block in `rem`.
+     */
+    maxHeight?: number;
+    /**
+     * Prompt symbol. Default is '$'.
+     */
+    promptSymbol?: string;
+    /**
+     * Should wrap the code block
+     * Default is false
+     */
+    shouldWrap?: boolean;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * CodeBlock UI component
+ */
+export declare const CodeBlock: ({ code, colorType, copyButtonLabel, hasCopyButton, hasLineNumbers, hasPrompt, language, maxHeight, promptSymbol, shouldWrap, className, ...props }: CodeBlockProps) => React.JSX.Element;
+export {};

package/_dist/components/CodeBlock/code-examples.d.ts

@@ -0,0 +1,5 @@
+export declare const logExample = "Already have image (with digest): us-docker.pkg.dev/prod-decoupled-shared/build-tools/pantheon-build:v1.0.8-node20\nThe framework expected according to the configuration is: gatsby.\nThe framework detected from the code is: vite\nERROR: Invalid option: false\ndeprecated-tools [options]\nUsage:\n  deprecated-tools -t node --min-version 18 [--max-version 20] --message-format \"Node version should be between %s and %s\" --message-data \"18 20\"\n  deprecated-tools -f .nvmrc --message-format \"The file %s is deprecated\" --message-data \".nvmrc\"\n\n  -t, --tool <tool>       Check if a tool is deprecated\n    --min-version <ver>         Minimum version supported for the tool\n    --max-version <ver>         Max version supported for the tool\n  --message-format <format>   Format of the deprecation message\n  --message-data <data>       Array of data to use in the deprecation message\n  -f, --file <file>       Check if a file is deprecated\n  --message-format <format>   Format of the deprecation message\n  --message-data <data>       Array of data to use in the deprecation message\n  -h, --help              Display this help message\nnpm WARN deprecated rimraf@2.6.3: Rimraf versions prior to v4 are no longer supported\nnpm WARN deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported\n\n> @pantheon-systems/pds-toolkit-react@1.0.0-dev.213 prepare\n> husky install\n\nhusky - Git hooks installed";
+export declare const reactExample = "export const ControlledExample = () => {\n  const defaultValue = 'This is a default value';\n  const [value, setValue] = useState(defaultValue);\n\n  // This is a comment for this component.\n  return (\n    <TextInput\n      id='text-input-controlled-example'\n      label='Controlled Input example'\n      type='text'\n      hasClearButton={true}\n      onClear={() => {\n        setValue('');\n      }}\n      onChange={(event: ChangeEvent<HTMLInputElement>) => setValue(event.target.value)}\n      value={value}\n    />\n  );\n};";
+export declare const cssExample = "@design-tokens url('node_modules://@pantheon-systems/pds-design-tokens/build/json/pds-design-tokens.json') format('style-dictionary3');\n\n.pds-file-diff {\n  align-items: center;\n  display: flex;\n  gap: 0.25rem;\n  height: 1.0625rem;\n  max-width: 100%;\n  width: 100%;\n\n  .pds-file-diff__total-changes {\n    color: var(--pds-color-foreground-default-secondary);\n    font-size: token('typography.size.XS' to rem);\n  }\n\n  .pds-file-diff__bars {\n    align-items: center;\n    display: flex;\n    gap: 0.125rem;\n    width: 100%;\n  }\n\n  .pds-file-diff__behind {\n    position: relative;\n\n    .pds-file-diff__behind-bar {\n      background-color: var(--pds-color-status-critical-utility);\n      border-bottom-left-radius: 6.25rem;\n      border-top-left-radius: 6.25rem;\n      height: 8px;\n      min-width: 1px;\n      right: 0px;\n      transition: width 0.3s ease;\n      width: 100%;\n    }\n  }\n\n  .pds-file-diff__ahead {\n    position: relative;\n\n    .pds-file-diff__ahead-bar {\n      background-color: var(--pds-color-status-success-utility);\n      border-bottom-right-radius: 6.25rem;\n      border-top-right-radius: 6.25rem;\n      height: 8px;\n      left: 0px;\n      min-width: 1px;\n      transition: width 0.3s ease;\n      width: 100%;\n    }\n  }\n\n  .pds-file-diff__tooltip {\n    display: block;\n    padding-inline: 0;\n  }\n}\n";
+export declare const diffExample = "diff --git a/influitive/index.css b/influitive/index.css\nindex 2069af6..b347ca3 100644\n--- a/influitive/index.css\n+++ b/influitive/index.css\n@@ -1,4 +1,4 @@\n #nav-container ul li.c-nav-list-item a.c-nav-item {\n   font-weight: 500 !important;\n-  font-family: 'Poppins', san-serif !important;\n+  font-family: 'Poppins', sans-serif !important;\n }";
+export declare const twigExample = "<div class=\"pds-status-badge pds-status-badge--{{ color|default('transparent')}}{% if extra_classes %} {{ extra_classes }}{% endif %}\">\n\n  {% if has_status_indicator %}\n    <span class=\"pds-status-badge__status pds-status-badge__status--{{ status_type }}\">\n      {% if status_type %}\n        <span class=\"visually-hidden\">Status: {{ status_type }}</span>\n      {% endif %}\n    </span>\n  {% endif %}\n\n  <span class=\"pds-status-badge__label\">{{ label }}</span>\n</div>";

package/_dist/components/CodeBlock/themes/index.d.ts

@@ -0,0 +1,2 @@
+export * from './pdsDark';
+export * from './pdsLight';

package/_dist/components/CodeBlock/themes/pdsDark.d.ts

@@ -0,0 +1,2 @@
+import type { PrismTheme } from 'prism-react-renderer';
+export declare const pdsDark: PrismTheme;

package/_dist/components/CodeBlock/themes/pdsLight.d.ts

@@ -0,0 +1,2 @@
+import type { PrismTheme } from 'prism-react-renderer';
+export declare const pdsLight: PrismTheme;

package/_dist/components/ComparisonList/ComparisonList.d.ts

@@ -0,0 +1,42 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import './comparison-list.css';
+interface TypeLabels {
+    included: string;
+    notIncluded: string;
+    addon: string;
+}
+export interface ListItems {
+    text: string;
+    type: 'included' | 'notIncluded' | 'addon';
+}
+export interface ComparisonListProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Icon labels
+     */
+    typeLabels?: TypeLabels;
+    /**
+     * List items
+     */
+    listItems?: ListItems[];
+    /**
+     * Text preceding the list. Optional.
+     */
+    listLabel?: string;
+    /**
+     * A link element using the router of your choice. Will be displayed below the list. Optional.
+     */
+    moreLink?: ReactNode;
+    /**
+     * Render the icon labels for screen readers.
+     */
+    renderTypeLabels?: boolean;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * ComparisonList UI component
+ */
+export declare const ComparisonList: ({ listItems, listLabel, moreLink, renderTypeLabels, typeLabels, className, ...props }: ComparisonListProps) => React.JSX.Element;
+export {};

package/_dist/components/DashboardStat/DashboardStat.d.ts

@@ -0,0 +1,28 @@
+import React, { ComponentPropsWithoutRef } from 'react';
+import './dashboard-stat.css';
+export type DashBoardStatStatus = 'success' | 'warning' | 'launch' | 'error' | 'ready' | 'notReady';
+/**
+ * Prop types for DashboardStat
+ */
+export interface DashboardStatProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Title of the stat, displayed as the main heading of the component.
+     */
+    title?: string;
+    /**
+     * Status of the stat, which determines the icon and icon color.
+     */
+    status?: DashBoardStatStatus;
+    /**
+     *  Value of the stat, displayed next to the status icon.
+     */
+    stat?: string | number;
+    /**
+     * Additional class names.
+     */
+    className?: string;
+}
+/**
+ * DashboardStat UI component
+ */
+export declare const DashboardStat: ({ title, status, stat, className, ...props }: DashboardStatProps) => React.JSX.Element;

package/_dist/components/FileDiff/FileDiff.d.ts

@@ -0,0 +1,35 @@
+import React, { ComponentPropsWithoutRef } from 'react';
+import './file-diff.css';
+/**
+ * Prop types for FileDiff
+ */
+export interface FileDiffProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     *  Number of added lines (green bar).
+     */
+    additions: number;
+    /**
+     * Number of removed lines (red bar).
+     */
+    deletions: number;
+    /**
+     * Object with strings for tooltips and screen reader labels.
+     */
+    labelStrings?: {
+        linesChanged?: string;
+        additions?: string;
+        deletions?: string;
+    };
+    /**
+     * Custom width in rems for the component. This will override the default.
+     */
+    componentWidth?: number;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * FileDiff UI component
+ */
+export declare const FileDiff: ({ additions, deletions, labelStrings, className, componentWidth, ...props }: FileDiffProps) => React.JSX.Element;

package/_dist/components/FlowSteps/FlowSteps.d.ts

@@ -0,0 +1,33 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import './flow-steps.css';
+export type FlowStep = {
+    /**
+     * The header text of the step
+     */
+    header: string | ReactNode;
+    /**
+     * The content of the step
+     */
+    content?: string | ReactNode;
+};
+/**
+ * Prop types for FlowSteps
+ */
+export interface FlowStepsProps extends ComponentPropsWithoutRef<'ol'> {
+    /**
+     * Alignment of the step content.
+     */
+    contentAlignment?: 'indented' | 'left';
+    /**
+     * The list of steps to display.
+     */
+    steps: FlowStep[];
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * FlowSteps UI component
+ */
+export declare const FlowSteps: ({ contentAlignment, steps, className, ...props }: FlowStepsProps) => React.JSX.Element;

package/_dist/components/FlowSteps/example-steps.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+export declare const stepsWithoutExtraContent: {
+    header: string;
+}[];
+export declare const stepsWithCode: ({
+    header: string;
+    content: React.JSX.Element;
+} | {
+    header: React.JSX.Element;
+    content: React.JSX.Element;
+})[];
+export declare const stepsWithText: {
+    header: string;
+    content: string;
+}[];

package/_dist/components/LinkNewWindow/LinkNewWindow.d.ts

@@ -0,0 +1,35 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import './link-new-window.css';
+/**
+ * Prop types for LinkNewWindow
+ */
+export interface LinkNewWindowProps extends ComponentPropsWithoutRef<'a'> {
+    /**
+     * Content for the LinkNewWindow.
+     */
+    children?: ReactNode;
+    /**
+     * Optional font size for the LinkNewWindow. If not provided, the font size will be inherited from the parent element.
+     */
+    fontSize?: 'sm' | 'md' | 'lg';
+    /**
+     * Is the link in the process of loading?
+     */
+    isLoading?: boolean;
+    /**
+     * Translation string for the "opens in a new window" message.
+     */
+    newWindowText?: string;
+    /**
+     * URL where the component should link to.
+     */
+    url: string;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * LinkNewWindow UI component
+ */
+export declare const LinkNewWindow: ({ children, fontSize, isLoading, newWindowText, url, className, ...props }: LinkNewWindowProps) => React.JSX.Element;

package/_dist/components/Modal/Modal.d.ts

@@ -0,0 +1,44 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import './modal.css';
+export interface ModalProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Aria label that describes the modal. Will default to the title if not provided.
+     */
+    ariaLabel?: string;
+    /**
+     * Main content for modal.
+     */
+    children?: ReactNode;
+    /**
+     * Text for close button aria-label attribute. Only used if hasCloseButton is true.
+     */
+    closeButtonLabel?: string;
+    /**
+     * Indicates if the built-in close button will be shown.
+     */
+    hasCloseButton?: boolean;
+    /**
+     * Is the modal open?
+     */
+    modalIsOpen?: boolean;
+    /**
+     * Function to set the modal open state.
+     */
+    setModalIsOpen?: (isOpen: boolean) => void;
+    /**
+     * The width of the modal.
+     */
+    size?: 'sm' | 'md' | 'lg' | 'xl';
+    /**
+     * Text for modal title
+     */
+    title: string;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * Modal UI component
+ */
+export declare const Modal: ({ ariaLabel, children, closeButtonLabel, hasCloseButton, modalIsOpen, setModalIsOpen, size, title, className, ...props }: ModalProps) => React.JSX.Element;

package/_dist/components/Pagination/Pagination.d.ts

@@ -0,0 +1,54 @@
+import React, { ComponentPropsWithoutRef } from 'react';
+import { HeadingLevelCommon } from '@libs/types/custom-types';
+import './pagination.css';
+/**
+ * Prop types for Pagination
+ */
+export interface PaginationProps extends ComponentPropsWithoutRef<'nav'> {
+    /**
+     * Minimum number of page buttons to buffer on either side of the current page.
+     * This will change the number of page buttons shown in total.
+     */
+    bufferCount?: number;
+    /**
+     * Current page number.
+     */
+    currentPage: number;
+    /**
+     *  Heading level. Defaults to `h2`.
+     */
+    headingLevel?: HeadingLevelCommon;
+    /**
+     * Heading text for the pagination component. Will only be accessible to screen readers.
+     */
+    headingText?: string;
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: number;
+    /**
+     * Label strings for previous and next buttons.
+     */
+    labelStrings?: {
+        previous: string;
+        next: string;
+    };
+    /**
+     * Callback to handle page change.
+     * Use a state hook to update the current page in a parent component.
+     * For example: `onPageChange={(page) => setCurrentPage(page)}`
+     */
+    onPageChange?: (page: number) => void;
+    /**
+     * Total number of items to paginate.
+     */
+    totalItemCount: number;
+    /**
+     * Additional class names.
+     */
+    className?: string;
+}
+/**
+ * Pagination UI component
+ */
+export declare const Pagination: ({ bufferCount, currentPage, headingLevel, headingText, itemsPerPage, labelStrings, onPageChange, totalItemCount, className, ...props }: PaginationProps) => React.JSX.Element;

package/_dist/components/Pagination/usePagination.d.ts

@@ -0,0 +1,7 @@
+export declare const ELLIPSIS = "...";
+export declare const usePagination: ({ bufferCount, currentPage, itemsPerPage, totalItemCount, }: {
+    bufferCount?: number;
+    currentPage: any;
+    itemsPerPage: any;
+    totalItemCount: any;
+}) => (string | number)[];

package/_dist/components/PantheonLogo/PantheonLogo.d.ts

@@ -0,0 +1,32 @@
+import React, { ComponentPropsWithoutRef, ReactNode } from 'react';
+import './pantheon-logo.css';
+export type PantheonLogoDisplayType = 'full' | 'icon' | 'wordmark' | 'sub-brand' | 'sub-brand-small';
+/**
+ * Prop types for PantheonLogo
+ */
+export interface PantheonLogoProps extends ComponentPropsWithoutRef<'div'> {
+    /**
+     * Color type. Use 'default' unless the logo is used on an approved dark background.
+     */
+    colorType?: 'default' | 'reverse';
+    /**
+     * Display type
+     */
+    displayType?: PantheonLogoDisplayType;
+    /**
+     * 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`.
+     */
+    linkContent?: ReactNode;
+    /**
+     * Accepts a fully-formed link or a string (if a static site name is desired). Will only render if the `display-type` is set to 'sub-brand'.
+     */
+    subBrand?: ReactNode | string;
+    /**
+     * Additional class names
+     */
+    className?: string;
+}
+/**
+ * PantheonLogo UI component
+ */
+export declare const PantheonLogo: ({ colorType, displayType, linkContent, subBrand, className, ...props }: PantheonLogoProps) => React.JSX.Element;

package/_dist/components/PantheonLogo/pantheon-logo-data.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+export declare const logoFull: React.JSX.Element;
+export declare const logoIcon: React.JSX.Element;
+export declare const logoWordmark: React.JSX.Element;