Function ToggleGroupItem

ToggleGroup components provide a set of two-state buttons that can be toggled on or off. These components are built on Radix UI primitives and styled with Shadcn UI.

See

  • ToggleGroupItem(
        props: Omit<
            ToggleGroupItemProps & RefAttributes<HTMLButtonElement>,
            "ref",
        > & VariantProps<
            (
                props?: ConfigVariants<{ variant: { default: string; outline: string; }; size: { default: string; sm: string; lg: string; }; }> & ClassProp,
            ) => string,
        > & RefAttributes<HTMLButtonElement>,
    ): ReactNode

    Parameters

    • props: Omit<ToggleGroupItemProps & RefAttributes<HTMLButtonElement>, "ref"> & VariantProps<
          (
              props?: ConfigVariants<{ variant: { default: string; outline: string; }; size: { default: string; sm: string; lg: string; }; }> & ClassProp,
          ) => string,
      > & RefAttributes<HTMLButtonElement>

    Returns ReactNode

Properties

$$typeof defaultProps? displayName? propTypes?

Properties

Readonly$$typeof

$$typeof: symbol

OptionaldefaultProps

defaultProps?: Partial<
    Omit<ToggleGroupItemProps & RefAttributes<HTMLButtonElement>, "ref"> & VariantProps<
        (
            props?: ConfigVariants<{ variant: { default: string; outline: string; }; size: { default: string; sm: string; lg: string; }; }> & ClassProp,
        ) => string,
    > & RefAttributes<HTMLButtonElement>,
>

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

OptionalpropTypes

propTypes?: WeakValidationMap<
    Omit<ToggleGroupItemProps & RefAttributes<HTMLButtonElement>, "ref"> & VariantProps<
        (
            props?: ConfigVariants<{ variant: { default: string; outline: string; }; size: { default: string; sm: string; lg: string; }; }> & ClassProp,
        ) => string,
    > & RefAttributes<HTMLButtonElement>,
>

Settings

Member Visibility

On This Page

Properties