@commercetools/nimbus 2.0.1-rc2 → 2.0.1-rc3

package/dist/tooltip.d.ts

@@ -1,131 +0,0 @@
-import { FocusableOptions } from 'react-aria';
-import { HTMLChakraProps } from '@chakra-ui/react';
-import { JSX } from 'react/jsx-runtime';
-import { JSXElementConstructor } from 'react';
-import { PropsWithChildren } from 'react';
-import { ReactElement } from 'react';
-import { RecipeProps } from '@chakra-ui/react';
-import { TooltipProps as TooltipProps_2 } from 'react-aria-components';
-import { TooltipTriggerComponentProps } from 'react-aria-components';
-import { UnstyledProp } from '@chakra-ui/react';
-
-/**
- * Utility type helpers for Nimbus components
- */
-/**
- * Excludes polymorphic props (`as` and `asChild`) from a type.
- *
- * **Use case:** For components that use the polymorphic `as` and `asChild` props
- * internally, but do not make them available to the consumer.
- *
- * **Background:**
- * React-Aria's components cannot be configured to use `as` and `asChild` internally,
- * and cannot be directly styled by Chakra's styledSystem. Therefore components
- * from `react-aria-components` should be wrapped in a Chakra `withContext`
- * root component to set the styles onto the `r-a-c` component using `asChild`.
- * This means that we need to allow polymorphism internally, but should not
- * allow it in the external props API since it would not work.
- *
- * @template T - The type to exclude polymorphic props from
- *
- * @example
- * ```typescript
- * export type AccordionItemProps = ExcludePolymorphicFromProps<
- *   RaDisclosureProps & HTMLChakraProps<"div">
- * > & {
- *   children: ReactNode;
- * };
- * ```
- */
-declare type ExcludePolymorphicFromProps<T> = Omit<T, "as" | "asChild">;
-
-/**
- * MakeElementFocusable
- * ============================================================
- * A helper component that adds props from `react-aria`s `useFocusable` hook
- * to its child so that it can be used as a trigger element for a `Tooltip`
- *
- * Caveats:
- * - Using non-interactive elements as tooltip triggers is against ARIA best-practices,
- *   it is your responsibility to ensure that the underlying trigger element handles
- *   focus and hover interactions correctly for keyboard-only users
- *
- * Features:
- * - allows forwarding refs to the underlying DOM element
- * - accepts all native html 'HTMLElement' attributes (including aria- & data-attributes)
- *
- * Further Context:
- * - [React Aria Components Tooltip Documentation](https://react-spectrum.adobe.com/react-aria/Tooltip.html)
- * - [React Aria Components Issue re:Tooltip with custom trigger](https://github.com/adobe/react-spectrum/issues/5733#issuecomment-1918691983)
- * - [ARIA Tooltip Pattern](https://www.w3.org/TR/wai-aria-1.2/#tooltip)
- */
-export declare const MakeElementFocusable: {
-    ({ ref: forwardedRef, children, ...props }: MakeElementFocusableProps): ReactElement<unknown, string | JSXElementConstructor<any>> | null;
-    displayName: string;
-};
-
-export declare type MakeElementFocusableProps = PropsWithChildren<FocusableOptions<HTMLElement>> & {
-    /**
-     * React ref to be forwarded to the underlying element
-     */
-    ref?: React.Ref<HTMLElement>;
-};
-
-export declare const Tooltip: {
-    Root: typeof _TooltipRoot;
-    Content: typeof _TooltipContent;
-};
-
-/**
- * TooltipContent
- * ============================================================
- * A contextual popup that displays a description for an element, uses `Tooltip` component from `react-aria-components`.
- *
- * Features:
- * - allows forwarding refs to the underlying DOM element
- * - accepts all native html 'HTMLDivElement' attributes (including aria- & data-attributes)
- * - allows overriding styles by using style-props
- *
- * Further Context:
- * - [React Aria Components Tooltip Documentation](https://react-spectrum.adobe.com/react-aria/Tooltip.html)
- * - [ARIA Tooltip Pattern](https://www.w3.org/TR/wai-aria-1.2/#tooltip)
- */
-export declare function _TooltipContent({ children, placement, ref, ...props }: TooltipProps & {
-    ref?: React.Ref<HTMLDivElement>;
-}): JSX.Element;
-
-export declare namespace _TooltipContent {
-    var displayName: string;
-}
-
-export declare type TooltipProps = PropsWithChildren<TooltipVariantProps>;
-
-declare type TooltipRecipeProps = RecipeProps<"tooltip"> & UnstyledProp;
-
-/**
- * # Tooltip
- *
- * A contextual popup that displays a description for an element.
- *
- * @see {@link https://nimbus-documentation.vercel.app/components/feedback/tooltip}
- */
-export declare function _TooltipRoot({ delay, closeDelay, ...props }: TooltipTriggerComponentProps): JSX.Element;
-
-export declare namespace _TooltipRoot {
-    var displayName: string;
-}
-
-export declare type TooltipRootSlotProps = HTMLChakraProps<"div", TooltipRecipeProps>;
-
-declare type TooltipVariantProps = ExcludePolymorphicFromProps<TooltipRootSlotProps & TooltipProps_2>;
-
-export { }
-
-
-declare module "slate" {
-    interface CustomTypes {
-        Editor: BaseEditor & ReactEditor & HistoryEditor;
-        Element: CustomElement;
-        Text: CustomText;
-    }
-}

package/dist/visually-hidden.d.ts

@@ -1,31 +0,0 @@
-import { JSX } from 'react/jsx-runtime';
-import { VisuallyHiddenProps as VisuallyHiddenProps_2 } from 'react-aria';
-
-/**
- * # VisuallyHidden
- *
- * makes content accessible to screen readers but hides it visually
- *
- * @see {@link https://nimbus-documentation.vercel.app/components/accessibility/visually-hidden}
- */
-export declare const VisuallyHidden: {
-    (props: VisuallyHiddenProps): JSX.Element;
-    displayName: string;
-};
-
-export declare type VisuallyHiddenProps = Omit<VisuallyHiddenProps_2, "elementType"> & {
-    /** specifies the element type to render, use `span` for inline content
-     * and `div` for block content */
-    as?: "span" | "div";
-};
-
-export { }
-
-
-declare module "slate" {
-    interface CustomTypes {
-        Editor: BaseEditor & ReactEditor & HistoryEditor;
-        Element: CustomElement;
-        Text: CustomText;
-    }
-}