@fayegram-ai/faye-ui/core/surface
Public exports and dependency-resolved component properties, with usage and rendering guidance.
Import
import { Surface, Card, CardHeader, CardBody, CardFooter, CardTitle, CardDescription, CardMedia, CardActions, CardPrimaryAction } from '@fayegram-ai/faye-ui/core/surface';Usage and behavior guide · API JSON
This entry has no declared client boundary; individual exported behavior still follows its rendering contract.
Public exports
| Name | Kind | Resolved declaration type |
|---|---|---|
Surface | value | ({ variant, padding, profile, className, ...props }: SurfaceProps) => import("react").JSX.Element |
Card | value | ({ profile, variant, padding, className, ...props }: SurfaceProps) => import("react").JSX.Element |
CardHeader | value | ({ profile, avatar, action, className, children, ...props }: CardPartProps & { avatar?: ReactNode; action?: ReactNode; }) => import("react").JSX.Element |
CardBody | value | ({ profile, className, ...props }: CardPartProps) => import("react").JSX.Element |
CardFooter | value | ({ className, ...props }: CardPartProps) => import("react").JSX.Element |
CardTitle | value | ({ profile, className, level, ...props }: HTMLAttributes<HTMLHeadingElement> & { profile?: ComponentProfile; level?: 1 | 2 | 3 | 4 | 5 | 6; ref?: Ref<HTMLHeadingElement>; }) => import("react").JSX.Element |
CardDescription | value | ({ profile, className, ...props }: HTMLAttributes<HTMLParagraphElement> & { profile?: ComponentProfile; ref?: Ref<HTMLParagraphElement>; }) => import("react").JSX.Element |
CardMedia | value | ({ profile, className, ratio, style, children, ...props }: CardPartProps & { ratio?: number; }) => import("react").JSX.Element |
CardActions | value | ({ profile, className, ...props }: CardPartProps) => import("react").JSX.Element |
CardPrimaryAction | value | ({ profile, className, ...props }: CardPrimaryActionProps) => import("react").JSX.Element |
SurfaceProps | type | SurfaceProps |
CardPartProps | type | CardPartProps |
CardPrimaryActionProps | type | CardPrimaryActionProps |
Surface
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
padding | No | VisualVariant<"surface", "padding"> | undefined | See the usage contract and declaration. |
profile | No | ComponentProfile | undefined | See the usage contract and declaration. |
ref | No | Ref<HTMLDivElement> | undefined | See the usage contract and declaration. |
variant | No | VisualVariant<"surface", "variant"> | undefined | See the usage contract and declaration. |
Card
Static cards use explicit profiles, including on their individual parts.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
padding | No | VisualVariant<"surface", "padding"> | undefined | See the usage contract and declaration. |
profile | No | ComponentProfile | undefined | See the usage contract and declaration. |
ref | No | Ref<HTMLDivElement> | undefined | See the usage contract and declaration. |
variant | No | VisualVariant<"surface", "variant"> | undefined | See the usage contract and declaration. |
CardHeader
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
action | No | ReactNode | See the usage contract and declaration. |
avatar | No | ReactNode | See the usage contract and declaration. |
profile | No | ComponentProfile | undefined | See the usage contract and declaration. |
ref | No | Ref<HTMLDivElement> | undefined | See the usage contract and declaration. |
CardBody
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
profile | No | ComponentProfile | undefined | See the usage contract and declaration. |
ref | No | Ref<HTMLDivElement> | undefined | See the usage contract and declaration. |
CardFooter
Compatibility name for the card's actions region.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
profile | No | ComponentProfile | undefined | See the usage contract and declaration. |
ref | No | Ref<HTMLDivElement> | undefined | See the usage contract and declaration. |
CardTitle
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
level | No | 2 | 3 | 1 | 5 | 4 | 6 | undefined | See the usage contract and declaration. |
profile | No | ComponentProfile | undefined | See the usage contract and declaration. |
ref | No | Ref<HTMLHeadingElement> | undefined | See the usage contract and declaration. |
CardDescription
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
profile | No | ComponentProfile | undefined | See the usage contract and declaration. |
ref | No | Ref<HTMLParagraphElement> | undefined | See the usage contract and declaration. |
CardMedia
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
profile | No | ComponentProfile | undefined | See the usage contract and declaration. |
ratio | No | number | undefined | See the usage contract and declaration. |
ref | No | Ref<HTMLDivElement> | undefined | See the usage contract and declaration. |
CardActions
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
profile | No | ComponentProfile | undefined | See the usage contract and declaration. |
ref | No | Ref<HTMLDivElement> | undefined | See the usage contract and declaration. |
CardPrimaryAction
A stretched native primary control; actions in CardActions/Header.action remain independent.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
href | No | string | undefined | See the usage contract and declaration. |
profile | No | ComponentProfile | undefined | See the usage contract and declaration. |
ref | No | ((instance: HTMLAnchorElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLAnchorElement | null> | ((instance: HTMLButtonElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLButtonElement | null> | null | undefined | See the usage contract and declaration. |
Defaults and customization
Descriptor defaults: {"variant":"outlined","padding":"md"}. Parts: root. Explicit instance props take precedence over configured defaults.
Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.
State, events and accessibility
For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.
Declaration authority
Generated from packages/faye-ui/dist/core/surface.d.ts after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. React DOM attributes and Base UI component contracts describe the inherited foundations.