API Documentation Comments

March 31, 2026 · View on GitHub

This project uses @cloudscape-design/documenter to generate API docs from JSDoc comments in component interface files (src/<component>/interfaces.ts).

Special Tags

@i18n — marks internationalization properties
@analytics — marks analytics metadata properties (used internally in AWS)
@deprecated — marks deprecated properties. It should be indicated which other prop is recommended instead
@displayname — overrides the display name (e.g. children → text)
@awsuiSystem — tags a property or import by internal system (e.g. @awsuiSystem core), (used internally in AWS)

Sub-types

Define union types as named type aliases in the component's namespace, not as inline unions. Then reference them in the interface: variant?: ButtonProps.Variant.