Function SizedBox

A Box UI control that will be sized to the specified height and width. A padding of 4px will be used.

  • SizedBox(
        props: BoxOwnProps<Theme> & Omit<
            Omit<
                DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
                "ref",
            > & { ref?: Ref<HTMLDivElement> },
            keyof BoxOwnProps<Theme>,
        > & MUIStyledCommonProps<Theme> & { height?: number; width?: number },
        deprecatedLegacyContext?: any,
    ): ReactNode

  • Parameters

    • props: BoxOwnProps<Theme> & Omit<
          Omit<
              DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
              "ref",
          > & { ref?: Ref<HTMLDivElement> },
          keyof BoxOwnProps<Theme>,
      > & MUIStyledCommonProps<Theme> & { height?: number; width?: number }
    • OptionaldeprecatedLegacyContext: any

      Deprecated

      See

      React Docs

    Returns ReactNode

Properties

__emotion_styles contextTypes? defaultProps? displayName? propTypes?

Methods

withComponent

Properties

__emotion_styles

__emotion_styles: any

OptionalcontextTypes

contextTypes?: ValidationMap<any>

Deprecated

Lets you specify which legacy context is consumed by this component.

See

Legacy React Docs

OptionaldefaultProps

defaultProps?: Partial<
    BoxOwnProps<Theme> & Omit<
        Omit<
            DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
            "ref",
        > & { ref?: Ref<HTMLDivElement> },
        keyof BoxOwnProps<Theme>,
    > & MUIStyledCommonProps<Theme> & { height?: number; width?: number },
>

Used to define default values for the props accepted by the component.

See

React Docs

Example

type Props = { name?: string }

const MyComponent: FC<Props> = (props) => {
  return <div>{props.name}</div>
}

MyComponent.defaultProps = {
  name: 'John Doe'
}

Deprecated

Use values for destructuring assignments instead.

OptionaldisplayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Example


const MyComponent: FC = () => {
  return <div>Hello!</div>
}

MyComponent.displayName = 'MyAwesomeComponent'

OptionalpropTypes

propTypes?: WeakValidationMap<
    BoxOwnProps<Theme> & Omit<
        Omit<
            DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
            "ref",
        > & { ref?: Ref<HTMLDivElement> },
        keyof BoxOwnProps<Theme>,
    > & MUIStyledCommonProps<Theme> & { height?: number; width?: number },
>

Used to declare the types of the props accepted by the component. These types will be checked during rendering and in development only.

We recommend using TypeScript instead of checking prop types at runtime.

See

React Docs

Methods

withComponent

  • withComponent<C extends ComponentClass<ComponentProps<C>>>(
        component: C,
    ): StyledComponent<
        BoxOwnProps<Theme> & Omit<
            Omit<
                DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
                "ref",
            > & { ref?: Ref<HTMLDivElement> },
            keyof BoxOwnProps<Theme>,
        > & MUIStyledCommonProps<Theme> & { height?: number; width?: number } & LibraryManagedAttributes<
            C,
            ComponentProps<C>,
        >,
        { ref?: Ref<InstanceType<C>> },
    >

  • Type Parameters

    • C extends ComponentClass<ComponentProps<C>>

    Parameters

    • component: C

    Returns StyledComponent<
        BoxOwnProps<Theme> & Omit<
            Omit<
                DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
                "ref",
            > & { ref?: Ref<HTMLDivElement> },
            keyof BoxOwnProps<Theme>,
        > & MUIStyledCommonProps<Theme> & { height?: number; width?: number } & LibraryManagedAttributes<
            C,
            ComponentProps<C>,
        >,
        { ref?: Ref<InstanceType<C>> },
    >

  • withComponent<C extends ComponentType<ComponentProps<C>>>(
        component: C,
    ): StyledComponent<
        BoxOwnProps<Theme> & Omit<
            Omit<
                DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
                "ref",
            > & { ref?: Ref<HTMLDivElement> },
            keyof BoxOwnProps<Theme>,
        > & MUIStyledCommonProps<Theme> & { height?: number; width?: number } & LibraryManagedAttributes<
            C,
            ComponentProps<C>,
        >,
    >

  • Type Parameters

    • C extends ComponentType<ComponentProps<C>>

    Parameters

    • component: C

    Returns StyledComponent<
        BoxOwnProps<Theme> & Omit<
            Omit<
                DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
                "ref",
            > & { ref?: Ref<HTMLDivElement> },
            keyof BoxOwnProps<Theme>,
        > & MUIStyledCommonProps<Theme> & { height?: number; width?: number } & LibraryManagedAttributes<
            C,
            ComponentProps<C>,
        >,
    >

  • withComponent<Tag extends keyof IntrinsicElements>(
        tag: Tag,
    ): StyledComponent<
        BoxOwnProps<Theme> & Omit<
            Omit<
                DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
                "ref",
            > & { ref?: Ref<HTMLDivElement> },
            keyof BoxOwnProps<Theme>,
        > & MUIStyledCommonProps<Theme> & { height?: number; width?: number },
        IntrinsicElements[Tag],
    >

  • Type Parameters

    • Tag extends keyof IntrinsicElements

    Parameters

    Returns StyledComponent<
        BoxOwnProps<Theme> & Omit<
            Omit<
                DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
                "ref",
            > & { ref?: Ref<HTMLDivElement> },
            keyof BoxOwnProps<Theme>,
        > & MUIStyledCommonProps<Theme> & { height?: number; width?: number },
        IntrinsicElements[Tag],
    >

Settings

Member Visibility

On This Page

Properties
Methods