Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
React Native docs
Data displayReact Native

Icon

Display the complete shared interface and brand catalog, with platform-native escape hatches.

Public APILumenIconReact Native

Native example

Use Icon

Prefer a generated Lumen name when an interface or brand icon should remain consistent across platforms. Use an SF Symbol, ImageVector, or React Native graphic component when the operating system or product owns the artwork.

View verified React Native runtime capture
Icon rendered in the Expo web renderer Lumen playground
Verified runtime captureExpo web renderer
tsx
<LumenIcon
  name="search"
  label="Search"
  size="md"
/>

<LumenIcon name="brand:github" label="GitHub" />

React Native icon catalog

Choose an icon name

Search the visual catalogs, copy the displayed Lumen name, then use the React Native spelling below. The package includes both catalogs without another native dependency.

Brand icons

Use the platform form brand:github. Brand marks retain their Font Awesome attribution and may be protected trademarks.

Browse all brand icon names

Platform or product artwork

Use icon={ProductMark} when the operating system or your product owns the symbol instead of Lumen.

Reference

Public API

The primary shared and platform-specific options exposed by LumenIcon.

APIValues or typeDefaultDescription
name or iconLumenIconName or LumenIconGraphicExactly one requiredSelects a generated catalog icon or a platform-specific custom graphic.
labelString?nilNames a meaningful icon for assistive technology.
sizesm · md · lgmdUses a 16, 20, or 24 unit icon size.
colorNative colorinkOverrides the semantic icon color.

Native behavior

Design and accessibility

When to use it

Prefer a generated Lumen name when an interface or brand icon should remain consistent across platforms. Use an SF Symbol, ImageVector, or React Native graphic component when the operating system or product owns the artwork.

Accessibility

Standalone icons are decorative when no label or content description is supplied. Meaningful icons require a concise accessible name.

Shared component

Available on other platforms

Apple / SwiftUIAndroid / Compose
React Native docsNative primitives