Skip to content

BadgeProps — @gj-kit/expo-ui

A public interface from @gj-kit/expo-ui. The signature below is taken directly from the 0.8.1 release declaration.

import { BadgeProps } from '@gj-kit/expo-ui';
interface BadgeProps extends Omit<CommonProps, 'unstyled'> {
label: string;
/**
* Overrides the accessible name derived from the visible label — for example
* "Paid (PAID)" while the visible label stays localized. When present, the
* badge is exposed as one accessibility element carrying this name: native
* flattens the accessible root, and the web root takes `role="img"` with the
* label hidden from assistive technology, because ARIA prohibits naming a
* role-less generic element.
*/
accessibilityLabel?: string | undefined;
/** Defaults to 'neutral'. */
variant?: StatusVariant | undefined;
/** Defaults to 'md'. */
size?: BadgeSize | undefined;
/** A static node, or an icon render function that receives color and size. */
leading?: ReactNode | RenderIcon | undefined;
labelStyle?: StyleProp<TextStyle> | undefined;
labelClassName?: string | undefined;
unstyled?: never;
}

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

  • Package: @gj-kit/expo-ui
  • Version: 0.8.1
  • Public entry: .
  • Source: GitHub