@sanity-labs/ui-poc 0.0.1-alpha.12 → 0.0.1-alpha.14

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import type {ComponentProps} from 'react'
-import type {ComponentPropsWithRef} from 'react'
-import type {ElementType} from 'react'
+import {ComponentPropsWithRef} from 'react'
+import {ElementType} from 'react'
 import {JSX} from 'react/jsx-runtime'
+import type {default as React_2} from 'react'
 import type {SVGProps} from 'react'
 
 declare const ALIGN_ITEMS: readonly ['baseline', 'center', 'flex-end', 'flex-start', 'stretch']
@@ -37,6 +38,48 @@ declare interface BoxProps<T extends React.ElementType> extends LayoutProps {
   display?: Responsive<DisplayBlock>
 }
 
+/** @public */
+export declare function Button<T extends ElementType = 'button'>({
+  density,
+  level,
+  tone,
+  ...props
+}: ButtonProps<T> & Omit<ComponentPropsWithRef<T>, keyof ButtonProps<T>>): JSX.Element
+
+declare const BUTTON_DENSITY: readonly ['regular', 'loose']
+
+declare const BUTTON_LEVEL: readonly ['primary', 'secondary', 'tertiary']
+
+declare const BUTTON_TONE: readonly ['neutral', 'critical']
+
+declare type ButtonDensity = (typeof BUTTON_DENSITY)[number]
+
+declare type ButtonLevel = (typeof BUTTON_LEVEL)[number]
+
+/** @public */
+declare interface ButtonProps<T extends React.ElementType> {
+  /** Element to render */
+  as?: InteractiveAs<T>
+  /** Composite prop for setting padding and gap */
+  density?: ButtonDensity
+  /** Set CSS **width** property to 100% */
+  fullWidth?: Responsive<boolean>
+  /** Starting icon */
+  iconStart?: React.ElementType | React.ReactNode
+  /** Ending icon */
+  iconEnd?: React.ElementType | React.ReactNode
+  /** Button level */
+  level?: ButtonLevel
+  /** Loading state */
+  loading?: boolean
+  /** Button text */
+  text?: string
+  /** Button tone */
+  tone?: ButtonTone
+}
+
+declare type ButtonTone = (typeof BUTTON_TONE)[number]
+
 /** @public */
 export declare function Card<T extends ElementType = 'div'>({
   density,
@@ -57,27 +100,31 @@ export declare function Checkbox(props: CheckboxProps): JSX.Element
 
 /** @beta */
 declare interface CheckboxProps extends React.ComponentProps<'input'>, MarginProps {
-  /** Input label */
-  label: React.ReactNode
+  /** Error state */
+  error?: boolean
   /** Indeterminate state */
   indeterminate?: boolean
+  /** Input label */
+  label: React.ReactNode
 }
 
 /** @public */
-export declare function Code<T extends React.ElementType = 'pre'>({
+export declare function Code<T extends CodeTag = 'pre'>({
   size,
   ...props
-}: CodeProps & Omit<React.ComponentPropsWithRef<T>, keyof CodeProps>): JSX.Element
+}: CodeProps<T> & Omit<ComponentPropsWithRef<T>, keyof CodeProps<T>>): JSX.Element
 
 declare const CODE_SIZE: readonly [0, 1, 2, 3, 4]
 
 declare const CODE_TAG: readonly ['pre', 'span']
 
 /** @public */
-declare interface CodeProps
-  extends React.ComponentProps<'pre'>, Omit<TypographyProps, 'align' | 'lineClamp' | 'tone'> {
+declare interface CodeProps<T extends CodeTag> extends Omit<
+  TypographyProps,
+  'align' | 'lineClamp' | 'tone'
+> {
   /** Element to render */
-  as?: CodeTag
+  as?: T
   /** Refractor language for syntax highlighting */
   language?: string
   /** CSS **font-size** property */
@@ -177,11 +224,11 @@ declare type FontWeight = (typeof FONT_WEIGHT)[number]
 
 declare type GapProps = {
   /** CSS **gap** property */
-  gap?: Responsive<Space>
+  gap?: Responsive<SpaceInherit>
   /** CSS **row-gap** property */
-  rowGap?: Responsive<Space>
+  rowGap?: Responsive<SpaceInherit>
   /** CSS **column-gap** property */
-  columnGap?: Responsive<Space>
+  columnGap?: Responsive<SpaceInherit>
 }
 
 /** @public */
@@ -263,23 +310,83 @@ declare type HeightProps = {
   maxHeight?: Responsive<string>
 }
 
+/** @public */
+export declare function HStack<T extends ElementType = 'div'>(
+  props: HStackProps<T> & Omit<ComponentPropsWithRef<T>, keyof HStackProps<T>>,
+): JSX.Element
+
+/** @public */
+declare interface HStackProps<T extends React.ElementType> extends Pick<GapProps, 'gap'> {
+  /** Element to render */
+  as?: T
+}
+
 /** @public */
 export declare function Icon({icon: Component, size, ...props}: IconProps): JSX.Element
 
 declare const ICON_SIZE: readonly [0, 1, 2, 3, 4]
 
 /** @public */
-declare interface IconProps extends ComponentProps<'svg'>, MarginProps, ToneProps {
+declare interface IconProps
+  extends ComponentProps<'svg'>, Pick<TypographyProps, 'muted'>, MarginProps, ToneProps {
   /** Icon to render */
   icon: React.ComponentType<SVGProps<SVGSVGElement>>
   /** CSS **font-size** property */
   size?: Responsive<IconSize>
-  /** CSS **color** property */
-  muted?: TypographyProps['muted']
 }
 
 declare type IconSize = (typeof ICON_SIZE)[number]
 
+/** @beta */
+export declare function Indicator<T extends ElementType = 'span'>({
+  tone,
+  ...props
+}: IndicatorProps<T> & Omit<ComponentPropsWithRef<T>, keyof IndicatorProps<T>>): JSX.Element
+
+/** @public */
+export declare function IndicatorGroup<T extends ElementType = 'div'>(
+  props: IndicatorGroupProps<T> & Omit<ComponentPropsWithRef<T>, keyof IndicatorGroupProps<T>>,
+): JSX.Element
+
+/** @public */
+declare interface IndicatorGroupProps<T extends React.ElementType> {
+  /** Element to render */
+  as?: T
+}
+
+/** @beta */
+declare interface IndicatorProps<T extends React.ElementType> extends ToneProps {
+  /** Element to render */
+  as?: T
+  /** Label for aria-label attribute */
+  label?: string
+}
+
+/** @deprecated Use HStack component instead */
+/** @public */
+export declare function Inline<T extends ElementType = 'div'>(
+  props: InlineProps<T> & Omit<ComponentPropsWithRef<T>, keyof InlineProps<T>>,
+): JSX.Element
+
+/** @deprecated Use HStack component instead */
+/** @public */
+declare interface InlineProps<T extends React.ElementType> extends PaddingProps {
+  /** Element to render */
+  as?: T
+  /** CSS **gap** property */
+  gap?: Responsive<SpaceInherit>
+}
+
+declare const INTERACTIVE_TAG: readonly ['button', 'a']
+
+declare type InteractiveAs<T extends React.ElementType> = T extends InteractiveTag
+  ? T
+  : T extends string
+    ? never
+    : T
+
+declare type InteractiveTag = (typeof INTERACTIVE_TAG)[number]
+
 declare const JUSTIFY_CONTENT: readonly [
   'flex-start',
   'flex-end',
@@ -298,6 +405,7 @@ export declare function Label(props: LabelProps): JSX.Element
 declare interface LabelProps extends React.ComponentProps<'label'>, MarginProps {
   /** Element to render */
   disabled?: boolean
+  error?: boolean
 }
 
 declare interface LayoutProps
@@ -315,21 +423,86 @@ declare interface LayoutProps
     ZIndexProps,
     ShadowProps {}
 
+/** @beta */
+export declare function Link({underlined, ...props}: LinkProps): JSX.Element
+
+/** @beta */
+declare interface LinkProps extends React.ComponentProps<'a'> {
+  /** If true, sets `target="_blank"` and `rel="noopener noreferrer"` */
+  openInNewTab?: boolean
+  /**
+   * If true, sets `text-decoration: underline`
+   *
+   * @defaultValue true
+   */
+  underlined?: boolean
+}
+
+/** @beta */
+export declare const List: typeof ListRoot
+
+declare const LIST_TAG: readonly ['ol', 'ul']
+
+declare function ListItem({density, ...props}: ListItemProps): JSX.Element
+
+declare function ListItemImage(props: ComponentProps<'img'>): JSX.Element
+
+/** @beta */
+declare interface ListItemProps extends React_2.ComponentProps<'li'> {
+  /** Composite prop for setting padding and gap */
+  density?: Responsive<Density>
+  /** Trailing slot */
+  trailing?: React_2.ReactNode
+}
+
+declare function ListItemText<T extends ElementType = 'div'>(
+  props: ListItemTextProps<T> & Omit<ComponentPropsWithRef<T>, keyof ListItemTextProps<T>>,
+): JSX.Element
+
+/** @beta */
+declare interface ListItemTextProps<T extends React_2.ElementType> {
+  /** Element to render */
+  as?: T
+  /** Title text */
+  title?: React_2.ReactNode
+  /** Subtitle text */
+  subtitle?: React_2.ReactNode
+}
+
+/** @beta */
+declare interface ListProps<T extends ListTag> {
+  /** Element to render */
+  as?: T
+}
+
+declare function ListRoot<T extends ListTag = 'ul'>(
+  props: ListProps<T> & Omit<ComponentPropsWithRef<T>, keyof ListProps<T>>,
+): JSX.Element
+
+declare namespace ListRoot {
+  var displayName: string
+  var Item: typeof ListItem
+  var ItemText: typeof ListItemText
+  var ItemImage: typeof ListItemImage
+}
+
+declare type ListTag = (typeof LIST_TAG)[number]
+
 declare type MarginProps = {
   /** CSS **margin** property */
-  margin?: Responsive<SpaceAuto>
+  margin?: Responsive<SpaceAutoNegative>
   /** CSS **margin-left** and **margin-right** properties */
-  marginX?: Responsive<SpaceAuto>
+  marginX?: Responsive<SpaceAutoNegative>
   /** CSS **margin-top** and **margin-bottom** properties */
-  marginY?: Responsive<SpaceAuto>
+  marginY?: Responsive<SpaceAutoNegative>
   /** CSS **margin-top** property */
-  marginTop?: Responsive<SpaceAuto>
+  marginTop?: Responsive<SpaceAutoNegative>
   /** CSS **margin-right** property */
-  marginRight?: Responsive<SpaceAuto>
+  marginRight?: Responsive<SpaceAutoNegative>
   /** CSS **margin-bottom** property */
-  marginBottom?: Responsive<SpaceAuto>
+  marginBottom?: Responsive<SpaceAutoNegative>
   /** CSS **margin-left** property */
-  marginLeft?: Responsive<SpaceAuto>
+  marginLeft?: Responsive<SpaceAutoNegative>
 }
 
 declare const OVERFLOW: readonly ['visible', 'hidden', 'auto', 'scroll', 'clip']
@@ -386,6 +559,8 @@ export declare function Radio(props: RadioProps): JSX.Element
 
 /** @beta */
 declare interface RadioProps extends React.ComponentProps<'input'>, MarginProps {
+  /** Error state */
+  error?: boolean
   /** Input label */
   label: React.ReactNode
 }
@@ -421,23 +596,77 @@ declare type ShadowProps = {
   shadow?: string
 }
 
+/** @beta */
+export declare function SkipToContent(props: SkipToContentProps): JSX.Element
+
+/** @beta */
+declare interface SkipToContentProps extends React.ComponentProps<'a'> {
+  /**
+   * Anchor hash. The target element should be focusable or have `tabindex="-1"` applied.
+   */
+  hash: string
+  /** Use href instead */
+  href?: never
+  /** Visible/announced label */
+  label: string
+  /** Use label instead */
+  children?: never
+}
+
 declare const SPACE: readonly [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 
 declare type Space = (typeof SPACE)[number]
 
 declare const SPACE_AUTO: readonly [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 'auto']
 
+declare const SPACE_AUTO_NEGATIVE: readonly [
+  -9,
+  -8,
+  -7,
+  -6,
+  -5,
+  -4,
+  -3,
+  -2,
+  -1,
+  0,
+  1,
+  2,
+  3,
+  4,
+  5,
+  6,
+  7,
+  8,
+  9,
+  'auto',
+]
+
+declare const SPACE_INHERIT: readonly [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 'inherit']
+
 declare type SpaceAuto = (typeof SPACE_AUTO)[number]
 
+declare type SpaceAutoNegative = (typeof SPACE_AUTO_NEGATIVE)[number]
+
+declare type SpaceInherit = (typeof SPACE_INHERIT)[number]
+
+/** @public */
+export declare function Spinner({size, ...props}: SpinnerProps): JSX.Element
+
+/** @public */
+declare interface SpinnerProps extends React.ComponentProps<'svg'> {
+  size?: Responsive<IconSize>
+}
+
 /** @beta */
 export declare function Switch(props: SwitchProps): JSX.Element
 
 /** @beta */
 declare interface SwitchProps extends React.ComponentProps<'input'>, MarginProps {
+  /** Error state */
+  error?: boolean
   /** Input label */
   label: React.ReactNode
-  /** Indeterminate state */
-  indeterminate?: boolean
 }
 
 /** @public */
@@ -463,15 +692,7 @@ declare interface TextProps<T extends React.ElementType> extends TypographyProps
 
 declare type TextSize = (typeof TEXT_SIZE)[number]
 
-declare const TONE: readonly [
-  'none',
-  'neutral',
-  'primary',
-  'positive',
-  'suggest',
-  'caution',
-  'critical',
-]
+declare const TONE: readonly ['neutral', 'positive', 'suggest', 'caution', 'critical']
 
 declare type Tone = (typeof TONE)[number]
 
@@ -502,6 +723,19 @@ export declare function VisuallyHidden<T extends ElementType = 'span'>(
 declare interface VisuallyHiddenProps<T extends React.ElementType> {
   /** Element to render */
   as?: T
+  /** If true, element is visible on :focus-visible */
+  visibleOnFocus?: boolean
+}
+
+/** @public */
+export declare function VStack<T extends ElementType = 'div'>(
+  props: VStackProps<T> & Omit<ComponentPropsWithRef<T>, keyof VStackProps<T>>,
+): JSX.Element
+
+/** @public */
+declare interface VStackProps<T extends React.ElementType> extends Pick<GapProps, 'gap'> {
+  /** Element to render */
+  as?: T
 }
 
 declare type WidthProps = {