Skip to content

Function: icon()

ts
function icon(props: UiIconProps): Element;

Defined in: src/UI/blocks/icon.tsx:47

Icon component for displaying icons or text fallbacks.

Parameters

ParameterTypeDescription
propsUiIconPropsConfiguration object

Returns

Element

Examples

Basic usage with static icon

icon({
  icon: 'checkmark-circle'
});

Usage with dynamic icon from params with data and value

icon({
  icon: ({data}) => data.user.isOnline ? 'checkmark-circle' : 'close-circle',
  size: 24,
  color: '#007bff'
});

Usage with styling and margins

icon({
  icon: 'information-circle',
  size: 20,
  margin: [10, 5],
  className: 'custom-icon-class'
});

Matterway Assistant SDK Documentation