@ovok/native/content

Content cards, lists and detail screens for educational content.

  • Stable unknown
  • Release candidate since 1.16.1-rc.3
  • Development since 1.16.1-dev.2111+9796905

Content cards, lists and detail screens for educational content.

Import from @ovok/native/content.

Components

ContentCard()

function ContentCard(props): Element;

Card for a piece of content; compose it with the ContentCard.* sub-components.

Parameters

ParameterType
propsSurfaceCardProps

Returns

Element


ContentDetail()

function ContentDetail(__namedParameters): Element;

Scrollable detail view for a Composition; compose it with the ContentDetail.* sub-components.

Parameters

ParameterType
__namedParametersPropsWithChildren<ContentDetailProps>

Returns

Element


ContentList()

function ContentList<T>(__namedParameters): Element;

List of content sections; compose rows with the ContentList.* sub-components.

Type Parameters

Type Parameter
T extends DefaultContentData<T["contents"][number]>

Parameters

ParameterType
__namedParametersContentListProps<T>

Returns

Element


HorizontalList()

function HorizontalList<T>(__namedParameters): Element;

Horizontally scrolling list of content cards.

Type Parameters

Type Parameter
T extends object

Parameters

ParameterType
__namedParametersHorizontalListProps<T>

Returns

Element


Section()

function Section(props): Element;

Vertically spaced container for one content section.

Parameters

ParameterType
propsViewProps

Returns

Element


Title()

function Title<T>(__namedParameters): Element;

Section title text.

Type Parameters

Type Parameter
T extends MD3TypescaleKey

Parameters

ParameterType
__namedParametersProps<T>

Returns

Element


ViewAll()

function ViewAll<T>(__namedParameters): Element;

Small text link for opening the full list; defaults to the translated "view all" label.

Type Parameters

Type Parameter
T extends MD3TypescaleKey

Parameters

ParameterType
__namedParametersOmit<Props<T>, "children"> & object

Returns

Element

Hooks

useComposition()

function useComposition(): CompositionContextType;

Returns the composition context; must be used within a ContentDetail.

Returns

CompositionContextType

Type Aliases

CompositionContextType

type CompositionContextType = object;

Value of the composition context.

Properties

composition?
composition?: Composition;

The FHIR Composition shown by the content detail components.

Variables

CompositionContext

const CompositionContext: Context<CompositionContextType | null>;

Context holding the composition shown by the content detail components.

Last updated on

On this page