@sanity/ui 3.0.0-static.4 → 3.0.0-static.41

package/dist/_visual-editing.d.cts

@@ -0,0 +1,853 @@
+import type {AlignItems} from '@sanity/ui/css'
+import {BoxStyleProps} from '@sanity/ui/css'
+import type {ButtonStyleProps} from '@sanity/ui/css'
+import {CardStyleProps} from '@sanity/ui/css'
+import type {CardTone} from '@sanity/ui/theme'
+import type {ColorScheme} from '@sanity/ui/theme'
+import type {ComponentClass} from 'react'
+import type {ComponentProps} from 'react'
+import type {DisplayStyleProps} from '@sanity/ui/css'
+import type {ElementTone} from '@sanity/ui/theme'
+import {ElementType as ElementType_2} from 'react'
+import type {ExoticComponent} from 'react'
+import type {FlexDirection} from '@sanity/ui/css'
+import type {FlexWrap} from '@sanity/ui/css'
+import type {FontTextSize} from '@sanity/ui/theme'
+import type {FontWeight} from '@sanity/ui/theme'
+import {ForwardedRef} from 'react'
+import type {FunctionComponent} from 'react'
+import type {GapStyleProps} from '@sanity/ui/css'
+import {HTMLAttributes} from 'react'
+import {InputStyleProps} from '@sanity/ui/css'
+import type {JSX} from 'react'
+import type {JustifyContent} from '@sanity/ui/css'
+import {MaxWidth} from '@sanity/ui/css'
+import {PaddingStyleProps} from '@sanity/ui/css'
+import {RadiusStyleProps} from '@sanity/ui/css'
+import {ReactElement} from 'react'
+import {ReactNode} from 'react'
+import type {ReactPortal} from 'react'
+import {Ref} from 'react'
+import {RefAttributes} from 'react'
+import {ResponsiveProp} from '@sanity/ui/css'
+import {ShadowStyleProps} from '@sanity/ui/css'
+import type {Space} from '@sanity/ui/theme'
+import {TextOverflowStyleProps} from '@sanity/ui/css'
+import {TextStyleProps} from '@sanity/ui/css'
+import type {Width} from '@sanity/ui/css'
+
+/**
+ * Assign properties from `U` to `T`, excluding properties that already exist in `T`.
+ *
+ * @public
+ */
+declare type Assign<T extends {}, U extends {}> = Omit<T, keyof U> & U
+
+/**
+ * The `Box` component is a basic layout wrapper component which provides utility properties
+ * for flex, margins and padding.
+ *
+ * @public
+ */
+export declare function Box<E extends BoxElementType = typeof DEFAULT_BOX_ELEMENT>(
+  props: BoxProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type BoxElementType =
+  | 'a'
+  | 'article'
+  | 'aside'
+  | 'blockquote'
+  | 'body'
+  | 'button'
+  | 'details'
+  | 'div'
+  | 'header'
+  | 'fieldset'
+  | 'figure'
+  | 'figcaption'
+  | 'footer'
+  | 'form'
+  | 'html'
+  | 'iframe'
+  | 'kbd'
+  | 'label'
+  | 'legend'
+  | 'li'
+  | 'main'
+  | 'nav'
+  | 'ol'
+  | 'pre'
+  | 'section'
+  | 'span'
+  | 'summary'
+  | 'ul'
+  | ComponentType
+
+/** @public */
+declare type BoxOwnProps = BoxStyleProps
+
+/** @public */
+export declare type BoxProps<E extends BoxElementType = BoxElementType> = Props<BoxOwnProps, E>
+
+/** @public */
+export declare function Button<E extends ButtonElementType = typeof DEFAULT_BUTTON_ELEMENT>(
+  props: ButtonProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type ButtonElementType = 'a' | 'button' | 'label' | ComponentType
+
+/** @public */
+declare type ButtonOwnProps = ButtonStyleProps &
+  DisplayStyleProps &
+  GapStyleProps &
+  PaddingStyleProps & {
+    'align'?: BoxStyleProps['alignItems']
+    'data-ui'?: string
+    'disabled'?: boolean
+    'fontSize'?: ResponsiveProp<FontTextSize>
+    'icon'?: ElementType_2 | ReactNode
+    'iconRight'?: ElementType_2 | ReactNode
+    'justify'?: BoxStyleProps['justifyContent']
+    /** @beta Do not use in production, as this might change.*/
+    'loading'?: boolean
+    'selected'?: boolean
+    'textAlign'?: ButtonTextAlign
+    'muted'?: boolean
+    'target'?: string
+    'text'?: ReactNode
+    'textOverflow'?: TextOwnProps['textOverflow']
+    'textWeight'?: TextOwnProps['weight']
+    'width'?: ResponsiveProp<Width>
+  }
+
+/** @public */
+export declare type ButtonProps<E extends ButtonElementType = ButtonElementType> = Props<
+  ButtonOwnProps,
+  E
+>
+
+/** @public */
+declare type ButtonTextAlign = 'left' | 'right' | 'center'
+
+/**
+ * The `Card` component acts much like a `Box`, but with a background and foreground color.
+ * Components within a `Card` inherit its colors.
+ *
+ * @public
+ */
+export declare function Card<E extends CardElementType = typeof DEFAULT_CARD_ELEMENT>(
+  props: CardProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type CardElementType = BoxElementType
+
+/** @public */
+declare interface CardOwnProps extends BoxOwnProps, CardStyleProps {
+  /**
+   * Do not use in production.
+   * @beta
+   */
+  __unstable_checkered?: boolean
+  /**
+   * Do not use in production.
+   * @beta
+   */
+  __unstable_focusRing?: boolean
+  disabled?: boolean
+  pressed?: boolean
+  selected?: boolean
+  target?: string
+}
+
+/** @public */
+export declare type CardProps<E extends CardElementType = CardElementType> = Props<CardOwnProps, E>
+
+/** @public */
+declare type ComponentType<P = any> = FunctionComponent<P> | ComponentClass<P> | ExoticComponent<P>
+
+/** @public */
+declare const DEFAULT_BOX_ELEMENT = 'div'
+
+/** @public */
+declare const DEFAULT_BUTTON_ELEMENT = 'button'
+
+/** @public */
+declare const DEFAULT_CARD_ELEMENT = 'div'
+
+/** @public */
+declare const DEFAULT_FLEX_ELEMENT = 'div'
+
+/** @public */
+declare const DEFAULT_GRID_ELEMENT = 'div'
+
+/** @public */
+declare const DEFAULT_HOTKEYS_ELEMENT = 'kbd'
+
+/** @public */
+declare const DEFAULT_MENU_DIVIDER_ELEMENT = 'hr'
+
+/** @public */
+declare const DEFAULT_MENU_ELEMENT = 'div'
+
+/** @public */
+declare const DEFAULT_MENU_GROUP_ELEMENT = 'button'
+
+/** @public */
+declare const DEFAULT_MENU_ITEM_ELEMENT = 'button'
+
+/** @public */
+declare const DEFAULT_POPOVER_ELEMENT = 'div'
+
+/** @public */
+declare const DEFAULT_SPINNER_ELEMENT = 'div'
+
+/** @public */
+declare const DEFAULT_STACK_ELEMENT = 'div'
+
+/** @public */
+declare const DEFAULT_TAB_ELEMENT = 'button'
+
+/** @public */
+declare const DEFAULT_TAB_LIST_ELEMENT = 'div'
+
+/** @public */
+declare const DEFAULT_TEXT_ELEMENT = 'div'
+
+/** @public */
+declare const DEFAULT_TEXT_INPUT_ELEMENT = 'input'
+
+/** @public */
+declare const DEFAULT_TOOLTIP_ELEMENT = 'div'
+
+/** @public */
+declare type Delay =
+  | number
+  | Partial<{
+      open: number
+      close: number
+    }>
+
+/** @public */
+declare type ElementType<P> = TagType | ComponentType<P>
+
+/** @public */
+declare type EmptyProps = {}
+
+/**
+ * The `Flex` component is a wrapper component for flexible elements (`Box`, `Card` and `Flex`).
+ *
+ * @public
+ */
+export declare function Flex<E extends FlexElementType = typeof DEFAULT_FLEX_ELEMENT>(
+  props: FlexProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type FlexElementType = BoxElementType
+
+/** @public */
+declare type FlexOwnProps = Omit<
+  BoxOwnProps,
+  'align' | 'display' | 'flexDirection' | 'flexWrap'
+> & {
+  align?: ResponsiveProp<AlignItems>
+  direction?: ResponsiveProp<FlexDirection>
+  justify?: ResponsiveProp<JustifyContent>
+  wrap?: ResponsiveProp<FlexWrap>
+}
+
+/** @public */
+export declare type FlexProps<E extends FlexElementType = FlexElementType> = Props<FlexOwnProps, E>
+
+/**
+ * The `Grid` component is for building 2-dimensional layers (based on CSS grid).
+ *
+ * @public
+ */
+export declare function Grid<E extends GridElementType = typeof DEFAULT_GRID_ELEMENT>(
+  props: GridProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type GridElementType = BoxElementType
+
+/** @public */
+declare type GridOwnProps = Omit<BoxOwnProps, 'display'>
+
+/** @public */
+export declare type GridProps<E extends GridElementType = GridElementType> = Props<GridOwnProps, E>
+
+/**
+ * Represent hotkeys (a keyboard combination) with semantic `<kbd>` elements.
+ *
+ * @public
+ */
+export declare function Hotkeys<E extends HotkeysElementType = typeof DEFAULT_HOTKEYS_ELEMENT>(
+  props: HotkeysProps<E>,
+): React.JSX.Element | undefined
+
+/** @public */
+declare type HotkeysElementType = 'kbd' | ComponentType
+
+/** @public */
+declare interface HotkeysOwnProps extends GapStyleProps, RadiusStyleProps {
+  fontSize?: ResponsiveProp<FontTextSize>
+  padding?: ResponsiveProp<Space>
+  keys?: string[]
+}
+
+/** @public */
+export declare type HotkeysProps<E extends HotkeysElementType = HotkeysElementType> = Props<
+  HotkeysOwnProps,
+  E
+>
+
+/**
+ * @internal
+ */
+export declare function isHTMLAnchorElement(element: unknown): element is HTMLAnchorElement
+
+/**
+ * @internal
+ */
+export declare function isHTMLElement(node: unknown): node is HTMLElement
+
+/** @public */
+declare type LayerOwnProps = CardOwnProps & {
+  /** A callback that fires when the layer becomes the top layer when it was not the top layer before. */
+  onActivate?: (props: {activeElement: HTMLElement | null}) => void
+  zOffset?: ResponsiveProp<number>
+}
+
+/** @public */
+export declare function LayerProvider(props: LayerProviderProps): React.JSX.Element
+
+/** @public */
+declare interface LayerProviderProps {
+  children?: ReactNode
+  zOffset?: ResponsiveProp<number>
+}
+
+/**
+ * The `Menu` component is a building block for application menus.
+ *
+ * @public
+ */
+export declare function Menu<E extends MenuElementType = typeof DEFAULT_MENU_ELEMENT>(
+  props: MenuProps<E>,
+): React.JSX.Element
+
+/** @public */
+export declare function MenuDivider<
+  E extends MenuDividerElementType = typeof DEFAULT_MENU_DIVIDER_ELEMENT,
+>(props: MenuDividerProps<E>): React.JSX.Element
+
+/** @public */
+declare type MenuDividerElementType = 'div' | 'hr' | 'span' | ComponentType
+
+/** @public */
+declare type MenuDividerOwnProps = {}
+
+/** @public */
+declare type MenuDividerProps<E extends MenuDividerElementType = MenuDividerElementType> = Props<
+  MenuDividerOwnProps,
+  E
+>
+
+/** @public */
+declare type MenuElementType = 'div' | 'span' | ComponentType
+
+/** @public */
+export declare function MenuGroup<
+  E extends MenuGroupElementType = typeof DEFAULT_MENU_GROUP_ELEMENT,
+>(props: MenuGroupProps<E>): React.JSX.Element
+
+/** @public */
+declare type MenuGroupElementType = 'button' | ComponentType
+
+/** @public */
+declare type MenuGroupOwnProps = RadiusStyleProps & {
+  disabled?: boolean
+  fontSize?: ResponsiveProp<FontTextSize>
+  gap?: ResponsiveProp<Space>
+  icon?: ElementType_2 | ReactNode
+  menu?: Omit<
+    MenuProps<typeof DEFAULT_MENU_ELEMENT>,
+    | 'onClickOutside'
+    | 'onEscape'
+    | 'onItemClick'
+    | 'onKeyDown'
+    | 'onMouseEnter'
+    | 'registerElement'
+    | 'shouldFocus'
+    | 'onBlurCapture'
+  >
+  padding?: ResponsiveProp<Space>
+  popover?: Omit<PopoverProps, 'content' | 'open'>
+  text?: ReactNode
+  tone?: ElementTone
+}
+
+/** @public */
+export declare type MenuGroupProps<E extends MenuGroupElementType = MenuGroupElementType> = Props<
+  MenuGroupOwnProps,
+  E
+>
+
+/** @public */
+export declare function MenuItem<E extends MenuItemElementType = typeof DEFAULT_MENU_ITEM_ELEMENT>(
+  props: MenuItemProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type MenuItemElementType = 'button' | 'a' | ComponentType
+
+/** @public */
+declare type MenuItemOwnProps = GapStyleProps &
+  PaddingStyleProps &
+  RadiusStyleProps & {
+    disabled?: boolean
+    fontSize?: ResponsiveProp<FontTextSize>
+    hotkeys?: string[]
+    icon?: ElementType_2 | ReactNode
+    iconRight?: ElementType_2 | ReactNode
+    pressed?: boolean
+    selected?: boolean
+    text?: ReactNode
+    tone?: ElementTone
+  }
+
+/** @public */
+export declare type MenuItemProps<E extends MenuItemElementType = MenuItemElementType> = Omit<
+  Props<MenuItemOwnProps, E>,
+  'role'
+>
+
+/** @public */
+declare type MenuOwnProps = PaddingStyleProps & {
+  'gap'?: ResponsiveProp<Space>
+  'onClickOutside'?: (event: MouseEvent) => void
+  'onEscape'?: () => void
+  'onItemClick'?: () => void
+  'onItemSelect'?: (index: number) => void
+  'originElement'?: HTMLElement | null
+  'registerElement'?: (el: HTMLElement) => () => void
+  'shouldFocus'?: 'first' | 'last' | null
+  'aria-labelledby'?: string
+}
+
+/** @public */
+export declare type MenuProps<E extends MenuElementType = MenuElementType> = Props<MenuOwnProps, E>
+
+/**
+ * Placement of floating UI elements.
+ *
+ * @public
+ */
+declare type Placement =
+  | 'top'
+  | 'top-start'
+  | 'top-end'
+  | 'right'
+  | 'right-start'
+  | 'right-end'
+  | 'bottom'
+  | 'bottom-start'
+  | 'bottom-end'
+  | 'left'
+  | 'left-start'
+  | 'left-end'
+
+/**
+ * The `Popover` component is used to display some content on top of another.
+ *
+ * @public
+ */
+export declare function Popover<E extends PopoverElementType = typeof DEFAULT_POPOVER_ELEMENT>(
+  props: PopoverProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type PopoverElementType = 'div' | ComponentType
+
+/**
+ * @beta
+ */
+export declare type PopoverMargins = [number, number, number, number]
+
+/** @public */
+declare type PopoverOwnProps = Omit<LayerOwnProps, 'maxWidth'> & {
+  /** @beta */
+  __unstable_margins?: PopoverMargins
+  /**
+   * Whether the popover should animate in and out.
+   *
+   * @beta
+   * @defaultValue false
+   */
+  animate?: boolean
+  arrow?: boolean
+  children?: ReactElement<{
+    ref: ForwardedRef<HTMLElement>
+  }>
+  /**
+   * When `true`, prevent overflow within the current boundary:
+   * - by flipping on its side axis
+   * - by resizing
+   *
+   * Note that:
+   * - setting `preventOverflow` to `true` also prevents overflow on its side axis
+   * - setting `matchReferenceWidth` to `true` also causes the popover to resize
+   *
+   * @defaultValue false
+   */
+  constrainSize?: boolean
+  content?: ReactNode
+  disabled?: boolean
+  fallbackPlacements?: Placement[]
+  floatingBoundary?: HTMLElement | null
+  /**
+   * When `true`, set the maximum width to match the reference element, and also prevent overflow within
+   * the current boundary by resizing.
+   *
+   * Note that setting `constrainSize` to `true` also causes the popover to resize
+   *
+   * @defaultValue false
+   */
+  matchReferenceWidth?: boolean
+  /**
+   * When true, blocks all pointer interaction with elements beneath the popover until closed.
+   *
+   * @beta
+   * @defaultValue false
+   */
+  modal?: boolean
+  open?: boolean
+  placement?: Placement
+  /**
+   * When 'flip' (default), the placement is determined from the initial placement and the
+   * fallback placements in order. Whichever fits in the viewport first.
+   *
+   * When 'autoPlacement', the initial placement and all fallback placements are evaluated
+   * and the placement with the most viewport space available.
+   *
+   * Option is only relevant if either `constrainSize` or `preventOverflow` is `true`
+   */
+  placementStrategy?: 'flip' | 'autoPlacement'
+  /** Whether or not to render the popover in a portal element. */
+  portal?: boolean | string
+  preventOverflow?: boolean
+  referenceBoundary?: HTMLElement | null
+  /**
+   * When defined, the popover will be positioned relative to this element.
+   * The children of the popover won't be rendered.
+   */
+  referenceElement?: HTMLElement | null
+  /** @beta */
+  updateRef?: Ref<PopoverUpdateCallback | undefined>
+  width?: ResponsiveProp<MaxWidth>
+}
+
+/** @public */
+export declare type PopoverProps<E extends PopoverElementType = PopoverElementType> = Props<
+  PopoverOwnProps,
+  E
+>
+
+/** @beta */
+declare type PopoverUpdateCallback = () => void
+
+/** @public */
+export declare function Portal(props: PortalProps): ReactPortal | null
+
+/** @public */
+export declare interface PortalProps {
+  children: ReactNode
+  /**
+   * @beta This API might change. DO NOT USE IN PRODUCTION.
+   */
+  __unstable_name?: string
+}
+
+/** @public */
+export declare function PortalProvider(props: PortalProviderProps): React.JSX.Element
+
+/** @public */
+export declare interface PortalProviderProps {
+  children: ReactNode
+  element?: HTMLElement | null
+  /**
+   * @beta
+   */
+  __unstable_elements?: Record<string, HTMLElement | null | undefined>
+}
+
+/** @public */
+declare type Props<P extends EmptyProps, E extends ElementType<P>> = Assign<
+  E extends TagType ? JSX.IntrinsicElements[E] : ComponentProps<E>,
+  P & {
+    as?: E
+  }
+>
+
+/**
+ * Indicate that something is loading for an indeterminate amount of time.
+ *
+ * @public
+ */
+export declare function Spinner<E extends SpinnerElementType = typeof DEFAULT_SPINNER_ELEMENT>(
+  props: SpinnerProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type SpinnerElementType = 'div' | 'span' | ComponentType
+
+/** @public */
+declare type SpinnerOwnProps = {
+  muted?: boolean
+  size?: ResponsiveProp<FontTextSize>
+}
+
+/** @public */
+export declare type SpinnerProps<E extends SpinnerElementType = SpinnerElementType> = Props<
+  SpinnerOwnProps,
+  E
+>
+
+/**
+ * The `Stack` component is used to place elements on top of each other.
+ *
+ * @public
+ */
+export declare function Stack<E extends StackElementType = typeof DEFAULT_STACK_ELEMENT>(
+  props: StackProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type StackElementType = BoxElementType
+
+/** @public */
+declare type StackOwnProps = Omit<
+  BoxOwnProps,
+  | 'align'
+  | 'alignItems'
+  | 'columns'
+  | 'gridTemplateColumns'
+  | 'direction'
+  | 'display'
+  | 'flexDirection'
+  | 'flexWrap'
+  | 'gapX'
+  | 'gapY'
+  | 'justify'
+  | 'justifyContent'
+  | 'rows'
+  | 'gridTemplateRows'
+>
+
+/** @public */
+export declare type StackProps<E extends StackElementType = StackElementType> = Props<
+  StackOwnProps,
+  E
+>
+
+/** @public */
+export declare function Tab<E extends TabElementType = typeof DEFAULT_TAB_ELEMENT>(
+  props: TabProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type TabElementType = 'button' | ComponentType
+
+/** @public */
+export declare function TabList<E extends TabListElementType = typeof DEFAULT_TAB_LIST_ELEMENT>(
+  props: TabListProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type TabListChild = ReactElement<Props<TabProps, 'button'>> | null | undefined | false
+
+/** @public */
+declare type TabListElementType = 'div' | 'span' | ComponentType
+
+/** @public */
+declare type TabListOwnProps = Omit<FlexOwnProps, 'as' | 'height'> & {
+  children: TabListChild[]
+}
+
+/** @public */
+export declare type TabListProps<E extends TabListElementType = TabListElementType> = Props<
+  TabListOwnProps,
+  E
+>
+
+/** @public */
+declare type TabOwnProps = {
+  /**
+   * The `id` of the corresponding `TabPanel` component.
+   */
+  'aria-controls': string
+  'id': string
+  'icon'?: ElementType_2 | ReactNode
+  'focused'?: boolean
+  'fontSize'?: ResponsiveProp<FontTextSize>
+  'label'?: ReactNode
+  'padding'?: ResponsiveProp<Space>
+  'selected'?: boolean
+  'tone'?: ElementTone
+}
+
+/** @public */
+export declare type TabProps<E extends TabElementType = TabElementType> = Props<TabOwnProps, E>
+
+/** @public */
+declare type TagType = keyof JSX.IntrinsicElements
+
+/**
+ * The `Text` component is an agile, themed typographic element.
+ *
+ * @public
+ */
+declare function Text_2<E extends TextElementType = typeof DEFAULT_TEXT_ELEMENT>(
+  props: TextProps<E>,
+): React.JSX.Element
+export {Text_2 as Text}
+
+/** @public */
+declare type TextElementType =
+  | 'div'
+  | 'h1'
+  | 'h2'
+  | 'h3'
+  | 'h4'
+  | 'h5'
+  | 'h6'
+  | 'label'
+  | 'li'
+  | 'p'
+  | 'span'
+  | ComponentType
+
+/**
+ * Single line text input.
+ *
+ * @public
+ */
+export declare function TextInput<
+  E extends TextInputElementType = typeof DEFAULT_TEXT_INPUT_ELEMENT,
+>(props: TextInputProps<E>): React.JSX.Element
+
+/** @public */
+declare type TextInputClearButtonProps = Omit<
+  ButtonProps<'button'>,
+  'as' | 'onClick' | 'onMouseDown'
+>
+
+/** @public */
+declare type TextInputElementType = 'input' | ComponentType
+
+/** @public */
+declare type TextInputOwnProps = InputStyleProps & {
+  /**
+   * @beta
+   */
+  __unstable_disableFocusRing?: boolean
+  /**
+   * @beta
+   */
+  clearButton?: boolean | TextInputClearButtonProps
+  customValidity?: string
+  icon?: ElementType_2 | ReactNode
+  iconRight?: ElementType_2 | ReactNode
+  /**
+   * @beta
+   */
+  onClear?: () => void
+  prefix?: ReactNode
+  suffix?: ReactNode
+  weight?: FontWeight
+}
+
+/** @public */
+export declare type TextInputProps<E extends TextInputElementType = TextInputElementType> = Props<
+  TextInputOwnProps,
+  E
+>
+
+/** @public */
+declare type TextOwnProps = TextStyleProps & TextOverflowStyleProps
+
+/** @public */
+export declare type TextProps<E extends TextElementType = TextElementType> = Props<TextOwnProps, E>
+
+/**
+ * Tooltips display information when hovering, focusing or tapping.
+ *
+ * @public
+ */
+export declare function Tooltip<E extends TooltipElementType = typeof DEFAULT_TOOLTIP_ELEMENT>(
+  props: TooltipProps<E>,
+): React.JSX.Element
+
+/** @public */
+declare type TooltipElementType = 'div' | 'span' | ComponentType
+
+/** @public */
+declare type TooltipOwnProps = LayerOwnProps &
+  RadiusStyleProps &
+  ShadowStyleProps & {
+    /**
+     * Whether the tooltip should animate in and out.
+     *
+     * @beta
+     * @defaultValue false
+     */
+    animate?: boolean
+    arrow?: boolean
+    boundaryElement?: HTMLElement | null
+    children?: ReactElement<HTMLAttributes<HTMLElement> & RefAttributes<HTMLElement>>
+    content?: ReactNode
+    /**
+     * Adds a delay to open or close the tooltip.
+     *
+     * If only a `number` is passed, it will be used for both opening and closing.
+     *
+     * If an object `{open: number; close:number}` is passed, it can be used to set different delays for each action.
+     *
+     * @public
+     * @defaultValue 0
+     */
+    delay?: Delay
+    disabled?: boolean
+    fallbackPlacements?: Placement[]
+    placement?: Placement
+    /** Whether or not to render the tooltip in a portal element. */
+    portal?: boolean | string
+    scheme?: ColorScheme
+    tone?: CardTone
+  }
+
+/** @public */
+export declare type TooltipProps<E extends TooltipElementType = TooltipElementType> = Props<
+  TooltipOwnProps,
+  E
+>
+
+/**
+ * Returns true if a dark color scheme is preferred, false if a light color scheme is preferred or the preference is not known.
+ *
+ * @param getServerSnapshot - Only called during server-side rendering, and hydration if using hydrateRoot. Since the server environment doesn't have access to the DOM, we can't determine the current value of the media query and we assume `(prefers-color-scheme: light)` since it's the most common scheme (https://dev/reference/react/useSyncExternalStore#adding-support-for-server-rendering)
+ *
+ * If you persist the detected preference in a cookie or a header then you may implement your own server snapshot to read it.
+ * Chrome supports reading the `prefers-color-scheme` media query from a header if the server response: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-CH-Prefers-Color-Scheme
+ * @example https://gist.github.com/stipsan/13c0cccf8dfc34f4b44bb1b984baf7df
+ *
+ * @public
+ */
+export declare function usePrefersDark(getServerSnapshot?: () => boolean): boolean
+
+export {}