Maia Documentation

Appearance

maia.component-library / CustomBadgeProps

Interface: CustomBadgeProps ​

Defined in: lib/components/Atoms/Badge/Badge.tsx:28

Extends ​

  • PropsWithChildren<Omit<BadgeProps, "className">>

Properties ​

children? ​

optional children?: ReactNode

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/badge/badge.d.ts:11

Inherited from ​

React.PropsWithChildren.children

className? ​

optional className?: string

Defined in: lib/components/Atoms/Badge/Badge.tsx:29

color? ​

optional color?: "default" | "accent" | "danger" | "success" | "warning"

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/badge/badge.d.ts:14

Badge color.

Inherited from ​

React.PropsWithChildren.color

placement? ​

optional placement?: "bottom-left" | "bottom-right" | "top-left" | "top-right"

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/badge/badge.d.ts:16

Badge placement.

Inherited from ​

React.PropsWithChildren.placement

render? ​

optional render?: DOMRenderFunction<"span", undefined>

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/utils/dom.d.ts:16

Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components.

Requirements:

  • You must render the expected element type (e.g. if <button> is expected, you cannot render an <a>).
  • Only a single root DOM element can be rendered (no fragments).
  • You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.

Inherited from ​

React.PropsWithChildren.render

size? ​

optional size?: "lg" | "md" | "sm"

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/badge/badge.d.ts:18

Badge size.

Inherited from ​

React.PropsWithChildren.size

value? ​

optional value?: ReactNode

Defined in: lib/components/Atoms/Badge/Badge.tsx:30

variant? ​

optional variant?: "primary" | "secondary" | "soft"

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/badge/badge.d.ts:20

Badge variant.

Inherited from ​

React.PropsWithChildren.variant