@primer/react-brand 0.78.0 → 0.79.0-rc.6f0687c1

package/lib/FeatureComparisonTable/FeatureComparisonTableContext.d.ts

@@ -0,0 +1,32 @@
+import React from 'react';
+import type { BaseProps } from '../component-helpers';
+import { type FeatureComparisonTableGroupProps } from './sub-components/FeatureComparisonTableGroup';
+import { type FeatureComparisonTableItemProps } from './sub-components/FeatureComparisonTableItem';
+export type FeatureComparisonTableBaseProps<T> = Omit<BaseProps<T>, 'animate' | 'id' | 'ref'>;
+export type FeatureComparisonTableAnimatedBaseProps<T> = Omit<BaseProps<T>, 'id' | 'ref'>;
+export declare const testIds: {
+    root: string;
+    heading: string;
+    narrow: string;
+    table: string;
+    item: string;
+    label: string;
+    price: string;
+    group: string;
+    row: string;
+    rowHeading: string;
+    cell: string;
+};
+export type BreakpointCategory = keyof Exclude<NonNullable<FeatureComparisonTableGroupProps['expanded']>, boolean>;
+export type TableContextValue = {
+    instanceId: string;
+    breakpoint: BreakpointCategory;
+    items: Array<React.ReactElement<FeatureComparisonTableItemProps>>;
+    itemIndex: number;
+    groupIndex: number;
+    groupIdentity: string;
+    narrowGroupControlsRef: React.RefObject<Record<string, HTMLElement | null>>;
+    tableGroupControlsRef: React.RefObject<Record<string, HTMLButtonElement | null>>;
+};
+export declare const TableContext: React.Context<TableContextValue | undefined>;
+export declare const useTableContext: () => TableContextValue;

package/lib/FeatureComparisonTable/FeatureComparisonTableHelpers.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { type FeatureComparisonTableItemProps } from './sub-components/FeatureComparisonTableItem';
+export declare const getChildrenOfType: <P>(children: React.ReactNode[], type: React.JSXElementConstructor<P>) => React.ReactElement<P, string | React.JSXElementConstructor<any>>[];
+export declare const hasItemLabel: (item: React.ReactElement<FeatureComparisonTableItemProps>) => boolean;

package/lib/FeatureComparisonTable/index.d.ts

@@ -0,0 +1 @@
+export * from './FeatureComparisonTable';

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableCell.d.ts

@@ -0,0 +1,29 @@
+import { type PropsWithChildren } from 'react';
+import { type FeatureComparisonTableBaseProps } from '../FeatureComparisonTableContext';
+export declare const cellVariants: {
+    included: {
+        icon: import("@primer/octicons-react").Icon;
+        label: string;
+    };
+    unavailable: {
+        icon: import("@primer/octicons-react").Icon;
+        label: string;
+    };
+    unlimited: {
+        icon: import("@primer/octicons-react").Icon;
+        label: string;
+    };
+    refresh: {
+        icon: import("@primer/octicons-react").Icon;
+        label: string;
+    };
+};
+export type FeatureComparisonTableCellVariantProps = {
+    variant?: undefined;
+    variantAriaLabel?: never;
+} | {
+    variant: keyof typeof cellVariants;
+    variantAriaLabel?: string;
+};
+export type FeatureComparisonTableCellProps = PropsWithChildren<FeatureComparisonTableBaseProps<HTMLDivElement> & FeatureComparisonTableCellVariantProps>;
+export declare const FeatureComparisonTableCell: (props: FeatureComparisonTableCellProps) => import("react").JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableDescription.d.ts

@@ -0,0 +1,4 @@
+import { type PropsWithChildren } from 'react';
+import { type FeatureComparisonTableAnimatedBaseProps } from '../FeatureComparisonTableContext';
+export type FeatureComparisonTableDescriptionProps = PropsWithChildren<FeatureComparisonTableAnimatedBaseProps<HTMLParagraphElement>>;
+export declare const FeatureComparisonTableDescription: (props: FeatureComparisonTableDescriptionProps) => import("react").JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableGroup.d.ts

@@ -0,0 +1,10 @@
+import React, { type PropsWithChildren } from 'react';
+import { type FeatureComparisonTableBaseProps } from '../FeatureComparisonTableContext';
+export type FeatureComparisonTableGroupProps = PropsWithChildren<FeatureComparisonTableBaseProps<HTMLDivElement> & {
+    expanded?: boolean | {
+        narrow: boolean;
+        regular: boolean;
+        wide: boolean;
+    };
+}>;
+export declare const FeatureComparisonTableGroup: ({ children, className, expanded }: FeatureComparisonTableGroupProps) => React.JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableGroupHeading.d.ts

@@ -0,0 +1,4 @@
+import { type PropsWithChildren } from 'react';
+import { type HeadingProps } from '../../Heading';
+export type FeatureComparisonTableGroupHeadingProps = PropsWithChildren<Omit<HeadingProps, 'ref'>>;
+export declare const FeatureComparisonTableGroupHeading: ({ children, as, size, ...rest }: FeatureComparisonTableGroupHeadingProps) => import("react").JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableHeading.d.ts

@@ -0,0 +1,4 @@
+import { type PropsWithChildren } from 'react';
+import { type HeadingProps } from '../../Heading';
+export type FeatureComparisonTableHeadingProps = PropsWithChildren<Omit<HeadingProps, 'ref'>>;
+export declare const FeatureComparisonTableHeading: (props: FeatureComparisonTableHeadingProps) => import("react").JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableItem.d.ts

@@ -0,0 +1,4 @@
+import React, { type PropsWithChildren } from 'react';
+import { type FeatureComparisonTableBaseProps } from '../FeatureComparisonTableContext';
+export type FeatureComparisonTableItemProps = PropsWithChildren<FeatureComparisonTableBaseProps<HTMLDivElement>>;
+export declare const FeatureComparisonTableItem: ({ children, className }: FeatureComparisonTableItemProps) => React.JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableItemHeading.d.ts

@@ -0,0 +1,4 @@
+import { type PropsWithChildren } from 'react';
+import { type HeadingProps } from '../../Heading';
+export type FeatureComparisonTableItemHeadingProps = PropsWithChildren<Omit<HeadingProps, 'id' | 'ref'>>;
+export declare const FeatureComparisonTableItemHeading: (props: FeatureComparisonTableItemHeadingProps) => import("react").JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableLabel.d.ts

@@ -0,0 +1,4 @@
+import { type PropsWithChildren } from 'react';
+import { type FeatureComparisonTableBaseProps } from '../FeatureComparisonTableContext';
+export type FeatureComparisonTableLabelProps = PropsWithChildren<FeatureComparisonTableBaseProps<HTMLSpanElement>>;
+export declare const FeatureComparisonTableLabel: (props: FeatureComparisonTableLabelProps) => import("react").JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTablePrice.d.ts

@@ -0,0 +1,4 @@
+import { type PropsWithChildren } from 'react';
+import { type FeatureComparisonTableAnimatedBaseProps } from '../FeatureComparisonTableContext';
+export type FeatureComparisonTablePriceProps = PropsWithChildren<FeatureComparisonTableAnimatedBaseProps<HTMLParagraphElement>>;
+export declare const FeatureComparisonTablePrice: (props: FeatureComparisonTablePriceProps) => import("react").JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTablePrimaryAction.d.ts

@@ -0,0 +1,12 @@
+import React, { type PropsWithChildren } from 'react';
+import { type ButtonBaseProps } from '../../Button';
+export type FeatureComparisonTableActionBaseProps = Omit<ButtonBaseProps, 'block' | 'size' | 'variant'>;
+export type FeatureComparisonTableAnchorActionProps = {
+    as: 'a';
+    href: string;
+} & FeatureComparisonTableActionBaseProps & Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'id'>;
+export type FeatureComparisonTableButtonActionProps = {
+    as: 'button';
+} & FeatureComparisonTableActionBaseProps & Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, 'id'>;
+export type FeatureComparisonTableActionProps = PropsWithChildren<FeatureComparisonTableAnchorActionProps | FeatureComparisonTableButtonActionProps>;
+export declare const FeatureComparisonTablePrimaryAction: (props: FeatureComparisonTableActionProps) => React.JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableRow.d.ts

@@ -0,0 +1,4 @@
+import React, { type PropsWithChildren } from 'react';
+import { type FeatureComparisonTableBaseProps } from '../FeatureComparisonTableContext';
+export type FeatureComparisonTableRowProps = PropsWithChildren<FeatureComparisonTableBaseProps<HTMLDivElement>>;
+export declare const FeatureComparisonTableRow: ({ children, className }: FeatureComparisonTableRowProps) => React.JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableRowDescription.d.ts

@@ -0,0 +1,4 @@
+import { type PropsWithChildren } from 'react';
+import { type FeatureComparisonTableBaseProps } from '../FeatureComparisonTableContext';
+export type FeatureComparisonTableRowDescriptionProps = PropsWithChildren<FeatureComparisonTableBaseProps<HTMLParagraphElement>>;
+export declare const FeatureComparisonTableRowDescription: (props: FeatureComparisonTableRowDescriptionProps) => import("react").JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableRowHeading.d.ts

@@ -0,0 +1,4 @@
+import { type PropsWithChildren } from 'react';
+import { type FeatureComparisonTableBaseProps } from '../FeatureComparisonTableContext';
+export type FeatureComparisonTableRowHeadingProps = PropsWithChildren<FeatureComparisonTableBaseProps<HTMLDivElement>>;
+export declare const FeatureComparisonTableRowHeading: (props: FeatureComparisonTableRowHeadingProps) => import("react").JSX.Element;

package/lib/FeatureComparisonTable/sub-components/FeatureComparisonTableSecondaryAction.d.ts

@@ -0,0 +1,2 @@
+import { type FeatureComparisonTableActionProps } from './FeatureComparisonTablePrimaryAction';
+export declare const FeatureComparisonTableSecondaryAction: (props: FeatureComparisonTableActionProps) => import("react").JSX.Element;

package/lib/FeatureComparisonTable/sub-components/index.d.ts

@@ -0,0 +1,27 @@
+export { FeatureComparisonTableHeading } from './FeatureComparisonTableHeading';
+export type { FeatureComparisonTableHeadingProps } from './FeatureComparisonTableHeading';
+export { FeatureComparisonTableItemHeading } from './FeatureComparisonTableItemHeading';
+export type { FeatureComparisonTableItemHeadingProps } from './FeatureComparisonTableItemHeading';
+export { FeatureComparisonTableLabel } from './FeatureComparisonTableLabel';
+export type { FeatureComparisonTableLabelProps } from './FeatureComparisonTableLabel';
+export { FeatureComparisonTableDescription } from './FeatureComparisonTableDescription';
+export type { FeatureComparisonTableDescriptionProps } from './FeatureComparisonTableDescription';
+export { FeatureComparisonTablePrice } from './FeatureComparisonTablePrice';
+export type { FeatureComparisonTablePriceProps } from './FeatureComparisonTablePrice';
+export { FeatureComparisonTablePrimaryAction } from './FeatureComparisonTablePrimaryAction';
+export type { FeatureComparisonTableActionProps } from './FeatureComparisonTablePrimaryAction';
+export { FeatureComparisonTableSecondaryAction } from './FeatureComparisonTableSecondaryAction';
+export { FeatureComparisonTableItem } from './FeatureComparisonTableItem';
+export type { FeatureComparisonTableItemProps } from './FeatureComparisonTableItem';
+export { FeatureComparisonTableRowHeading } from './FeatureComparisonTableRowHeading';
+export type { FeatureComparisonTableRowHeadingProps } from './FeatureComparisonTableRowHeading';
+export { FeatureComparisonTableRowDescription } from './FeatureComparisonTableRowDescription';
+export type { FeatureComparisonTableRowDescriptionProps } from './FeatureComparisonTableRowDescription';
+export { FeatureComparisonTableCell } from './FeatureComparisonTableCell';
+export type { FeatureComparisonTableCellProps } from './FeatureComparisonTableCell';
+export { FeatureComparisonTableRow } from './FeatureComparisonTableRow';
+export type { FeatureComparisonTableRowProps } from './FeatureComparisonTableRow';
+export { FeatureComparisonTableGroupHeading } from './FeatureComparisonTableGroupHeading';
+export type { FeatureComparisonTableGroupHeadingProps } from './FeatureComparisonTableGroupHeading';
+export { FeatureComparisonTableGroup } from './FeatureComparisonTableGroup';
+export type { FeatureComparisonTableGroupProps } from './FeatureComparisonTableGroup';

package/lib/FeatureComparisonTable/useFeatureComparisonTableStickyHeaders.d.ts

@@ -0,0 +1,2 @@
+import { type RefObject } from 'react';
+export declare function useFeatureComparisonTableStickyHeaders(tableRef: RefObject<HTMLTableElement | null>, isWide: boolean, hasItems: boolean): boolean;