@atlaskit/primitives 0.1.0 → 0.2.0

package/dist/types/components/internal/box.partial.d.ts

@@ -1,348 +0,0 @@
-/** @jsx jsx */
-import { ComponentPropsWithoutRef, ComponentPropsWithRef, ElementType, FC, ReactElement, ReactNode } from 'react';
-import { Layer } from '../../constants';
-import type { BasePrimitiveProps } from '../types';
-export declare type BoxProps<T extends ElementType = 'div'> = Omit<ComponentPropsWithoutRef<T>, 'as' | 'className' | 'style'> & BasePrimitiveProps & BoxPropsBase<T>;
-declare type BoxPropsBase<T extends ElementType> = {
-    /**
-     * The DOM element to render as the Box. Defaults to `div`.
-     */
-    as?: T;
-    /**
-     * Elements to be rendered inside the Box.
-     */
-    children?: ReactNode;
-    /**
-     * The HTML className attribute.
-     *
-     * Before using this prop please ensure:
-     * - The styles cannot otherwise be achieved through `Box` directly.
-     * - The use case needs custom styles that cannot be designed or implemented differently
-     *
-     * Ensure you're using the `@atlaskit/eslint-plugin-design-system` with this prop to prevent unbounded usage.
-     *
-     * @see `@atlaskit/eslint-plugin-design-system`
-     */
-    className?: string;
-    /**
-     * Token representing background color with a fallback.
-     */
-    backgroundColor?: BackgroundColor;
-    /**
-     * Token representing shadow with a fallback
-     */
-    shadow?: Shadow;
-    /**
-     * Defines border style.
-     */
-    borderStyle?: BorderStyle;
-    /**
-     * Defines border width.
-     */
-    borderWidth?: BorderWidth;
-    /**
-     * Token representing border color with a fallback.
-     */
-    borderColor?: BorderColor;
-    /**
-     * Defines border radius.
-     */
-    borderRadius?: BorderRadius;
-    /**
-     * Used for providing a z-index.
-     */
-    layer?: Layer;
-    /**
-     * Defines the main axis direction.
-     * @deprecated
-     */
-    flexDirection?: FlexDirection;
-    /**
-     * Used to align children along the cross axis.
-     * @deprecated
-     */
-    alignItems?: FlexAlignItems;
-    /**
-     * Used to align children along the main axis.
-     * @deprecated
-     */
-    justifyContent?: FlexJustifyContent;
-    /**
-     * Defines what happens if content overflows the box.
-     */
-    overflow?: Overflow;
-    /**
-     * Shorthand for `paddingBlock` and `paddingInline` together.
-     *
-     * @see paddingBlock
-     * @see paddingInline
-     */
-    padding?: Padding;
-    /**
-     * Token representing CSS `paddingBlock`.
-     */
-    paddingBlock?: PaddingBlock;
-    /**
-     * Token representing CSS `paddingInline`.
-     */
-    paddingInline?: PaddingInline;
-    /**
-     * Token representing width.
-     * @experimental The existing tokens will be replaced to better reflect dimensions.
-     */
-    width?: Width;
-    /**
-     * Token representing height.
-     * @experimental The existing tokens will be replaced to better reflect dimensions.
-     */
-    height?: Height;
-    /**
-     * Defines display type and layout. Defaults to `flex`.
-     */
-    display?: Display;
-    /**
-     * CSS position property.
-     */
-    position?: Position;
-    ref?: ComponentPropsWithRef<T>['ref'];
-};
-declare type BoxComponent<T extends ElementType = 'div'> = (<T extends ElementType = 'div'>(props: BoxProps<T>) => ReactElement | null) & FC<BoxProps<T>>;
-/**
- * __Box__
- *
- * Box is a primitive component that has the design decisions of the Atlassian Design System baked in.
- * Renders a `div` by default.
- *
- * @internal
- */
-export declare const Box: BoxComponent;
-export default Box;
-declare type BorderStyle = keyof typeof borderStyleMap;
-declare const borderStyleMap: {
-    none: import("@emotion/react").SerializedStyles;
-    solid: import("@emotion/react").SerializedStyles;
-    dashed: import("@emotion/react").SerializedStyles;
-    dotted: import("@emotion/react").SerializedStyles;
-};
-declare type BorderWidth = keyof typeof borderWidthMap;
-declare const borderWidthMap: {
-    '0px': import("@emotion/react").SerializedStyles;
-    '1px': import("@emotion/react").SerializedStyles;
-    '2px': import("@emotion/react").SerializedStyles;
-    '3px': import("@emotion/react").SerializedStyles;
-};
-declare type BorderRadius = keyof typeof borderRadiusMap;
-declare const borderRadiusMap: {
-    normal: import("@emotion/react").SerializedStyles;
-    rounded: import("@emotion/react").SerializedStyles;
-    badge: import("@emotion/react").SerializedStyles;
-};
-/**
- * @experimental - this is likely to be removed
- */
-declare type FlexDirection = keyof typeof flexDirectionMap;
-declare const flexDirectionMap: {
-    column: import("@emotion/react").SerializedStyles;
-    row: import("@emotion/react").SerializedStyles;
-};
-/**
- * @experimental - this is likely to be removed
- */
-declare type FlexAlignItems = keyof typeof flexAlignItemsMap;
-declare const flexAlignItemsMap: {
-    center: import("@emotion/react").SerializedStyles;
-    baseline: import("@emotion/react").SerializedStyles;
-    flexStart: import("@emotion/react").SerializedStyles;
-    flexEnd: import("@emotion/react").SerializedStyles;
-    start: import("@emotion/react").SerializedStyles;
-    end: import("@emotion/react").SerializedStyles;
-};
-/**
- * @experimental - this is likely to be removed
- */
-declare type FlexJustifyContent = keyof typeof flexJustifyContentMap;
-declare const flexJustifyContentMap: {
-    center: import("@emotion/react").SerializedStyles;
-    flexStart: import("@emotion/react").SerializedStyles;
-    flexEnd: import("@emotion/react").SerializedStyles;
-    start: import("@emotion/react").SerializedStyles;
-    end: import("@emotion/react").SerializedStyles;
-};
-declare type Display = keyof typeof displayMap;
-declare const displayMap: {
-    block: import("@emotion/react").SerializedStyles;
-    inline: import("@emotion/react").SerializedStyles;
-    flex: import("@emotion/react").SerializedStyles;
-    inlineFlex: import("@emotion/react").SerializedStyles;
-    inlineBlock: import("@emotion/react").SerializedStyles;
-};
-declare type Position = keyof typeof positionMap;
-declare const positionMap: {
-    absolute: import("@emotion/react").SerializedStyles;
-    fixed: import("@emotion/react").SerializedStyles;
-    relative: import("@emotion/react").SerializedStyles;
-    static: import("@emotion/react").SerializedStyles;
-};
-declare type Overflow = keyof typeof overflowMap;
-declare const overflowMap: {
-    auto: import("@emotion/react").SerializedStyles;
-    hidden: import("@emotion/react").SerializedStyles;
-};
-/**
- * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::327e769aaa3da9422a919a0ca9490070>>
- * @codegenId dimensions
- * @codegenCommand yarn codegen-styles
- * @codegenParams ["width", "height"]
- */
-declare const widthMap: {
-    '100%': import("@emotion/react").SerializedStyles;
-    'size.100': import("@emotion/react").SerializedStyles;
-    'size.1000': import("@emotion/react").SerializedStyles;
-    'size.200': import("@emotion/react").SerializedStyles;
-    'size.300': import("@emotion/react").SerializedStyles;
-    'size.400': import("@emotion/react").SerializedStyles;
-    'size.500': import("@emotion/react").SerializedStyles;
-    'size.600': import("@emotion/react").SerializedStyles;
-};
-export declare type Width = keyof typeof widthMap;
-declare const heightMap: {
-    '100%': import("@emotion/react").SerializedStyles;
-    'size.100': import("@emotion/react").SerializedStyles;
-    'size.1000': import("@emotion/react").SerializedStyles;
-    'size.200': import("@emotion/react").SerializedStyles;
-    'size.300': import("@emotion/react").SerializedStyles;
-    'size.400': import("@emotion/react").SerializedStyles;
-    'size.500': import("@emotion/react").SerializedStyles;
-    'size.600': import("@emotion/react").SerializedStyles;
-};
-export declare type Height = keyof typeof heightMap;
-/**
- * @codegenEnd
- */
-/**
- * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::bb003484c6ad12a718912942b07dbf6e>>
- * @codegenId spacing
- * @codegenCommand yarn codegen-styles
- * @codegenParams ["padding", "paddingBlock", "paddingInline"]
- * @codegenDependency ../../../../tokens/src/artifacts/tokens-raw/atlassian-spacing.tsx <<SignedSource::167d3b69b159ae33e74d4ea5ab7eade6>>
- */
-declare const paddingMap: {
-    'space.0': import("@emotion/react").SerializedStyles;
-    'space.025': import("@emotion/react").SerializedStyles;
-    'space.050': import("@emotion/react").SerializedStyles;
-    'space.075': import("@emotion/react").SerializedStyles;
-    'space.100': import("@emotion/react").SerializedStyles;
-    'space.1000': import("@emotion/react").SerializedStyles;
-    'space.150': import("@emotion/react").SerializedStyles;
-    'space.200': import("@emotion/react").SerializedStyles;
-    'space.250': import("@emotion/react").SerializedStyles;
-    'space.300': import("@emotion/react").SerializedStyles;
-    'space.400': import("@emotion/react").SerializedStyles;
-    'space.500': import("@emotion/react").SerializedStyles;
-    'space.600': import("@emotion/react").SerializedStyles;
-    'space.800': import("@emotion/react").SerializedStyles;
-};
-export declare type Padding = keyof typeof paddingMap;
-declare const paddingBlockMap: {
-    'space.0': import("@emotion/react").SerializedStyles;
-    'space.025': import("@emotion/react").SerializedStyles;
-    'space.050': import("@emotion/react").SerializedStyles;
-    'space.075': import("@emotion/react").SerializedStyles;
-    'space.100': import("@emotion/react").SerializedStyles;
-    'space.1000': import("@emotion/react").SerializedStyles;
-    'space.150': import("@emotion/react").SerializedStyles;
-    'space.200': import("@emotion/react").SerializedStyles;
-    'space.250': import("@emotion/react").SerializedStyles;
-    'space.300': import("@emotion/react").SerializedStyles;
-    'space.400': import("@emotion/react").SerializedStyles;
-    'space.500': import("@emotion/react").SerializedStyles;
-    'space.600': import("@emotion/react").SerializedStyles;
-    'space.800': import("@emotion/react").SerializedStyles;
-};
-export declare type PaddingBlock = keyof typeof paddingBlockMap;
-declare const paddingInlineMap: {
-    'space.0': import("@emotion/react").SerializedStyles;
-    'space.025': import("@emotion/react").SerializedStyles;
-    'space.050': import("@emotion/react").SerializedStyles;
-    'space.075': import("@emotion/react").SerializedStyles;
-    'space.100': import("@emotion/react").SerializedStyles;
-    'space.1000': import("@emotion/react").SerializedStyles;
-    'space.150': import("@emotion/react").SerializedStyles;
-    'space.200': import("@emotion/react").SerializedStyles;
-    'space.250': import("@emotion/react").SerializedStyles;
-    'space.300': import("@emotion/react").SerializedStyles;
-    'space.400': import("@emotion/react").SerializedStyles;
-    'space.500': import("@emotion/react").SerializedStyles;
-    'space.600': import("@emotion/react").SerializedStyles;
-    'space.800': import("@emotion/react").SerializedStyles;
-};
-export declare type PaddingInline = keyof typeof paddingInlineMap;
-/**
- * @codegenEnd
- */
-/**
- * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::997d215fff7bb2f824f7a0f600fe892e>>
- * @codegenId colors
- * @codegenCommand yarn codegen-styles
- * @codegenParams ["border", "background", "shadow"]
- * @codegenDependency ../../../../tokens/src/artifacts/tokens-raw/atlassian-light.tsx <<SignedSource::10aa7e87eca39e4d6594a764e78e0698>>
- */
-declare const borderColorMap: {
-    readonly 'color.border': import("@emotion/react").SerializedStyles;
-    readonly disabled: import("@emotion/react").SerializedStyles;
-    readonly focused: import("@emotion/react").SerializedStyles;
-    readonly input: import("@emotion/react").SerializedStyles;
-    readonly inverse: import("@emotion/react").SerializedStyles;
-    readonly selected: import("@emotion/react").SerializedStyles;
-    readonly brand: import("@emotion/react").SerializedStyles;
-    readonly danger: import("@emotion/react").SerializedStyles;
-    readonly warning: import("@emotion/react").SerializedStyles;
-    readonly success: import("@emotion/react").SerializedStyles;
-    readonly discovery: import("@emotion/react").SerializedStyles;
-    readonly information: import("@emotion/react").SerializedStyles;
-    readonly bold: import("@emotion/react").SerializedStyles;
-};
-export declare type BorderColor = keyof typeof borderColorMap;
-declare const backgroundColorMap: {
-    readonly disabled: import("@emotion/react").SerializedStyles;
-    readonly input: import("@emotion/react").SerializedStyles;
-    readonly 'inverse.subtle': import("@emotion/react").SerializedStyles;
-    readonly neutral: import("@emotion/react").SerializedStyles;
-    readonly 'neutral.subtle': import("@emotion/react").SerializedStyles;
-    readonly 'neutral.bold': import("@emotion/react").SerializedStyles;
-    readonly selected: import("@emotion/react").SerializedStyles;
-    readonly 'selected.bold': import("@emotion/react").SerializedStyles;
-    readonly 'brand.bold': import("@emotion/react").SerializedStyles;
-    readonly danger: import("@emotion/react").SerializedStyles;
-    readonly 'danger.bold': import("@emotion/react").SerializedStyles;
-    readonly warning: import("@emotion/react").SerializedStyles;
-    readonly 'warning.bold': import("@emotion/react").SerializedStyles;
-    readonly success: import("@emotion/react").SerializedStyles;
-    readonly 'success.bold': import("@emotion/react").SerializedStyles;
-    readonly discovery: import("@emotion/react").SerializedStyles;
-    readonly 'discovery.bold': import("@emotion/react").SerializedStyles;
-    readonly information: import("@emotion/react").SerializedStyles;
-    readonly 'information.bold': import("@emotion/react").SerializedStyles;
-    readonly 'color.blanket': import("@emotion/react").SerializedStyles;
-    readonly 'color.blanket.selected': import("@emotion/react").SerializedStyles;
-    readonly 'color.blanket.danger': import("@emotion/react").SerializedStyles;
-    readonly 'elevation.surface': import("@emotion/react").SerializedStyles;
-    readonly 'elevation.surface.overlay': import("@emotion/react").SerializedStyles;
-    readonly 'elevation.surface.raised': import("@emotion/react").SerializedStyles;
-    readonly 'elevation.surface.sunken': import("@emotion/react").SerializedStyles;
-};
-export declare type BackgroundColor = keyof typeof backgroundColorMap;
-declare const shadowMap: {
-    readonly overflow: import("@emotion/react").SerializedStyles;
-    readonly 'overflow.perimeter': import("@emotion/react").SerializedStyles;
-    readonly 'overflow.spread': import("@emotion/react").SerializedStyles;
-    readonly overlay: import("@emotion/react").SerializedStyles;
-    readonly raised: import("@emotion/react").SerializedStyles;
-};
-export declare type Shadow = keyof typeof shadowMap;
-/**
- * @codegenEnd
- */