On this page

Icon

Requires:
@ray-js/ray≥0.5.10@ray-js/icons≥1.6.0

Description

Icon component providing a rich icon library, with customizable size and color. Starting from @ray-js/ray@1.6.0, the Icon component is no longer built-in and must be installed separately via @ray-js/icons.

Props

PropertyTypeRequiredDefaultDescription
type"icon-warning" | "icon-right" | "icon-up" | "icon-down" | "icon-right-copy" | "icon-right-copy1" | "icon-a-cloudsunboltfill" | "icon-a-cloudhailfill" | "icon-a-cloudrainfill" | "icon-deskclock" | "icon-a-cloudsleetfill" | "icon-a-arrowtrianglecapsulepath" | "icon-a-cloudfogfill" | "icon-a-clouddrizzlefill" | "icon-a-cloudsunrainfill" | "icon-a-crownfill" | "icon-a-deskclockfill" | "icon-a-envelopeopenfill" | "icon-a-desktopcomputerandarrowdown" | "icon-a-ferryfill" | "icon-a-dropfill" | "icon-a-cloudmoonfill" | "icon-a-icloudandarrowdownfill" | "icon-a-heartfill" | "icon-a-icloudcirclefill" | "icon-a-giftfill" | "icon-a-handpointupleftfill" | "icon-icon" | "icon-a-exclamationmarkicloudfill" | "icon-a-facesmilingfill" | "icon-a-cloudsunfill" | "icon-a-figurewalk" | "icon-a-envelopebadge" | "icon-a-locationnorthfill" | "icon-a-minussquarefill" | "icon-a-icloudslashfill" | "icon-a-lockicloudfill" | "icon-a-flamefill" | "icon-left" | "icon-a-linkicloudfill" | "icon-a-micfill" | "icon-icon-2" | "icon-a-latch2casefill" | "icon-a-exclamationmarkbubblefill" | "icon-a-pausefill" | "icon-a-paintbrushfill" | "icon-a-moonfill" | "icon-a-keyicloudfill" | "icon-a-messagefill" | "icon-a-envelopefill" | "icon-a-moonstarsfill" | "icon-a-icloudandarrowupfill" | "icon-checkmark-3" | "icon-a-locationcirclefill" | "icon-a-forwardendaltfill" | "icon-a-clockfill" | "icon-bonjour" | "icon-a-icloudcircle" | "icon-a-leaffill" | "icon-a-paintbrushpointedfill" | "icon-a-cloudsnowfill" | "icon-a-playfill" | "icon-a-plussquarefill" | "icon-a-minuscirclefill" | "icon-a-personicloudfill" | "icon-a-phonefill" | "icon-a-pawprintfill" | "icon-plus" | "icon-a-scribblevariable" | "icon-a-phoneandwaveformfill" | "icon-a-phonedownfill" | "icon-a-pluscirclefill" | "icon-a-repeat1" | "icon-a-printerfillandpaperfill" | "icon-a-scrollfill" | "icon-snow" | "icon-a-speakerwave1fill" | "icon-scissors" | "icon-a-playrectanglefill" | "icon-a-globeamericasfill" | "icon-a-dotradiowavesleftandright" | "icon-minus" | "icon-a-stopfill" | "icon-a-suitcasefill" | "icon-a-sunrisefill" | "icon-a-thermometersunfill" | "icon-a-trainsidefrontcar" | "icon-a-speakerwave3fill" | "icon-a-cloudheavyrainfill" | "icon-a-eyedropperhalffull" | "icon-a-sunminfill" | "icon-a-sunsetfill" | "icon-a-timersquare" | "icon-stopwatch" | "icon-thermometer" | "icon-repeat" | "icon-a-stopwatchfill" | "icon-a-sunmaxfill" | "icon-a-icloudfill" | "icon-a-tramfill" | "icon-tornado" | "icon-a-videoslashfill" | "icon-personalhotspot" | "icon-a-thermometersnowflake" | "icon-a-sunhazefill" | "icon-a-videofill" | "icon-sparkles" | "icon-a-facemaskfill" | "icon-a-wave3backwardcirclefill" | "icon-a-wave3leftcirclefill" | "icon-a-wandandstarsinverse" | "icon-a-wave3rightcirclefill" | "icon-xmark" | "icon-a-wave3right" | "icon-a-waveformandmic" | "icon-a-wifiexclamationmark" | "icon-wifi" | "icon-a-xmarkicloudfill" | "icon-wind" | "icon-timer" | "icon-a-wrenchandscrewdriverfill" | "icon-a-wave3forwardcirclefill" | "icon-a-lockfill" | "icon-a-wifislash" | "icon-a-windsnow" | "icon-a-wave3forward" | "icon-cancel" | "icon-a-arrowbackward" | "icon-a-arrowdown" | "icon-alarm" | "icon-a-alarmfill" | "icon-a-airplanedeparture" | "icon-a-arrowlefttolinealt" | "icon-a-arrowforward" | "icon-airplane" | "icon-a-arrow2squarepath" | "icon-a-antennaradiowavesleftandright" | "icon-a-arrowshapeturnuprightfill" | "icon-a-arrowcounterclockwise" | "icon-a-arrowturndownleft" | "icon-a-arrowturnupleft" | "icon-a-airplanearrival" | "icon-a-boltfill" | "icon-a-arrowturnrightup" | "icon-a-arrowcounterclockwiseicloudfill" | "icon-a-bellfill" | "icon-a-arrowupanddownandarrowleftandright" | "icon-a-beddoublefill" | "icon-a-arrowshapeturnupleft2fill" | "icon-a-arrowtrianglerightfillandlineverticalandarr" | "icon-a-bolthorizontalicloudfill" | "icon-a-boltheartfill" | "icon-a-arrowupleftanddownrightandarrowuprightan" | "icon-a-arrowclockwiseicloudfill" | "icon-a-arrowupbackwardandarrowdownforward" | "icon-a-arrowturndownright" | "icon-bold" | "icon-a-arrowleftarrowright" | "icon-a-bolthorizontalfill" | "icon-checkmark" | "icon-a-arrowrighttolinealt" | "icon-a-bubblerightfill" | "icon-checkmark-2" | "icon-clock" | "icon-a-carfill" | "icon-a-backwardendaltfill" | "icon-checkmark-4" | "icon-a-chevronright2" | "icon-a-cloudboltrainfill" | "icon-a-bolthorizontalcirclefill" | "icon-a-chevronleft2" | "icon-a-chevroncompactdown" | "icon-a-briefcasefill" | "icon-a-arrowturnupright" | "icon-a-cloudboltfill" | "icon-a-cloudfill" | "icon-a-bubbleleftandbubblerightfill" | "icon-a-bellbadgefill" | "icon-checkmark-1" | "icon-a-cloudmoonrainfill" | "icon-a-chevroncompactright" | "icon-a-crossfill" | "icon-a-busfill" | "icon-a-arrowturnleftup" | "icon-a-cloudmoonboltfill" | "icon-a-arrowtriangleleftfillandlineverticalandarro" | "icon-a-checkmarkicloudfill"Yesicon-warningIcon type (built-in icon name)
sizenumberNo16Icon size, in px
colorstringNo#333333Icon color

Valid Values

type
ValueDescriptionSince
icon-warningwarning icon (glyph code U+E600)-
icon-right又 icon (glyph code U+E72F)-
icon-up上 icon (glyph code U+E731)-
icon-down下 icon (glyph code U+E7A1)-
icon-right-copy又 icon (glyph code U+E7A2)-
icon-right-copy1又 icon (glyph code U+E7A3)-
icon-a-cloudsunboltfillcloud.sun.bolt.fill icon (glyph code U+E727)-
icon-a-cloudhailfillcloud.hail.fill icon (glyph code U+E728)-
icon-a-cloudrainfillcloud.rain.fill icon (glyph code U+E729)-
icon-deskclockdeskclock icon (glyph code U+E72A)-
icon-a-cloudsleetfillcloud.sleet.fill icon (glyph code U+E72B)-
icon-a-arrowtrianglecapsulepatharrow.triangle.capsulepath icon (glyph code U+E72C)-
icon-a-cloudfogfillcloud.fog.fill icon (glyph code U+E72D)-
icon-a-clouddrizzlefillcloud.drizzle.fill icon (glyph code U+E72E)-
icon-a-cloudsunrainfillcloud.sun.rain.fill icon (glyph code U+E730)-
icon-a-crownfillcrown.fill icon (glyph code U+E732)-
icon-a-deskclockfilldeskclock.fill icon (glyph code U+E733)-
icon-a-envelopeopenfillenvelope.open.fill icon (glyph code U+E734)-
icon-a-desktopcomputerandarrowdowndesktopcomputer.and.arrow.down icon (glyph code U+E735)-
icon-a-ferryfillferry.fill icon (glyph code U+E736)-
icon-a-dropfilldrop.fill icon (glyph code U+E737)-
icon-a-cloudmoonfillcloud.moon.fill icon (glyph code U+E738)-
icon-a-icloudandarrowdownfillicloud.and.arrow.down.fill icon (glyph code U+E739)-
icon-a-heartfillheart.fill icon (glyph code U+E73A)-
icon-a-icloudcirclefillicloud.circle.fill icon (glyph code U+E73B)-
icon-a-giftfillgift.fill icon (glyph code U+E73C)-
icon-a-handpointupleftfillhand.point.up.left.fill icon (glyph code U+E73D)-
icon-iconicon icon (glyph code U+E73E)-
icon-a-exclamationmarkicloudfillexclamationmark.icloud.fill icon (glyph code U+E73F)-
icon-a-facesmilingfillface.smiling.fill icon (glyph code U+E740)-
icon-a-cloudsunfillcloud.sun.fill icon (glyph code U+E741)-
icon-a-figurewalkfigure.walk icon (glyph code U+E742)-
icon-a-envelopebadgeenvelope.badge icon (glyph code U+E743)-
icon-a-locationnorthfilllocation.north.fill icon (glyph code U+E744)-
icon-a-minussquarefillminus.square.fill icon (glyph code U+E745)-
icon-a-icloudslashfillicloud.slash.fill icon (glyph code U+E746)-
icon-a-lockicloudfilllock.icloud.fill icon (glyph code U+E747)-
icon-a-flamefillflame.fill icon (glyph code U+E748)-
icon-lefticon-1 icon (glyph code U+E749)-
icon-a-linkicloudfilllink.icloud.fill icon (glyph code U+E74A)-
icon-a-micfillmic.fill icon (glyph code U+E74B)-
icon-icon-2icon-2 icon (glyph code U+E74C)-
icon-a-latch2casefilllatch.2.case.fill icon (glyph code U+E74D)-
icon-a-exclamationmarkbubblefillexclamationmark.bubble.fill icon (glyph code U+E74E)-
icon-a-pausefillpause.fill icon (glyph code U+E74F)-
icon-a-paintbrushfillpaintbrush.fill icon (glyph code U+E750)-
icon-a-moonfillmoon.fill icon (glyph code U+E751)-
icon-a-keyicloudfillkey.icloud.fill icon (glyph code U+E752)-
icon-a-messagefillmessage.fill icon (glyph code U+E753)-
icon-a-envelopefillenvelope.fill icon (glyph code U+E754)-
icon-a-moonstarsfillmoon.stars.fill icon (glyph code U+E755)-
icon-a-icloudandarrowupfillicloud.and.arrow.up.fill icon (glyph code U+E756)-
icon-checkmark-3checkmark-3 icon (glyph code U+E757)-
icon-a-locationcirclefilllocation.circle.fill icon (glyph code U+E758)-
icon-a-forwardendaltfillforward.end.alt.fill icon (glyph code U+E759)-
icon-a-clockfillclock.fill icon (glyph code U+E75A)-
icon-bonjourbonjour icon (glyph code U+E75B)-
icon-a-icloudcircleicloud.circle icon (glyph code U+E75C)-
icon-a-leaffillleaf.fill icon (glyph code U+E75D)-
icon-a-paintbrushpointedfillpaintbrush.pointed.fill icon (glyph code U+E75E)-
icon-a-cloudsnowfillcloud.snow.fill icon (glyph code U+E75F)-
icon-a-playfillplay.fill icon (glyph code U+E760)-
icon-a-plussquarefillplus.square.fill icon (glyph code U+E761)-
icon-a-minuscirclefillminus.circle.fill icon (glyph code U+E762)-
icon-a-personicloudfillperson.icloud.fill icon (glyph code U+E763)-
icon-a-phonefillphone.fill icon (glyph code U+E764)-
icon-a-pawprintfillpawprint.fill icon (glyph code U+E765)-
icon-plusplus icon (glyph code U+E766)-
icon-a-scribblevariablescribble.variable icon (glyph code U+E767)-
icon-a-phoneandwaveformfillphone.and.waveform.fill icon (glyph code U+E768)-
icon-a-phonedownfillphone.down.fill icon (glyph code U+E769)-
icon-a-pluscirclefillplus.circle.fill icon (glyph code U+E76A)-
icon-a-repeat1repeat.1 icon (glyph code U+E76B)-
icon-a-printerfillandpaperfillprinter.fill.and.paper.fill icon (glyph code U+E76C)-
icon-a-scrollfillscroll.fill icon (glyph code U+E76D)-
icon-snowsnow icon (glyph code U+E76E)-
icon-a-speakerwave1fillspeaker.wave.1.fill icon (glyph code U+E76F)-
icon-scissorsscissors icon (glyph code U+E770)-
icon-a-playrectanglefillplay.rectangle.fill icon (glyph code U+E771)-
icon-a-globeamericasfillglobe.americas.fill icon (glyph code U+E772)-
icon-a-dotradiowavesleftandrightdot.radiowaves.left.and.right icon (glyph code U+E773)-
icon-minusminus icon (glyph code U+E774)-
icon-a-stopfillstop.fill icon (glyph code U+E775)-
icon-a-suitcasefillsuitcase.fill icon (glyph code U+E776)-
icon-a-sunrisefillsunrise.fill icon (glyph code U+E777)-
icon-a-thermometersunfillthermometer.sun.fill icon (glyph code U+E778)-
icon-a-trainsidefrontcartrain.side.front.car icon (glyph code U+E779)-
icon-a-speakerwave3fillspeaker.wave.3.fill icon (glyph code U+E77A)-
icon-a-cloudheavyrainfillcloud.heavyrain.fill icon (glyph code U+E77B)-
icon-a-eyedropperhalffulleyedropper.halffull icon (glyph code U+E77C)-
icon-a-sunminfillsun.min.fill icon (glyph code U+E77D)-
icon-a-sunsetfillsunset.fill icon (glyph code U+E77E)-
icon-a-timersquaretimer.square icon (glyph code U+E77F)-
icon-stopwatchstopwatch icon (glyph code U+E780)-
icon-thermometerthermometer icon (glyph code U+E781)-
icon-repeatrepeat icon (glyph code U+E782)-
icon-a-stopwatchfillstopwatch.fill icon (glyph code U+E783)-
icon-a-sunmaxfillsun.max.fill icon (glyph code U+E784)-
icon-a-icloudfillicloud.fill icon (glyph code U+E785)-
icon-a-tramfilltram.fill icon (glyph code U+E786)-
icon-tornadotornado icon (glyph code U+E787)-
icon-a-videoslashfillvideo.slash.fill icon (glyph code U+E788)-
icon-personalhotspotpersonalhotspot icon (glyph code U+E789)-
icon-a-thermometersnowflakethermometer.snowflake icon (glyph code U+E78A)-
icon-a-sunhazefillsun.haze.fill icon (glyph code U+E78B)-
icon-a-videofillvideo.fill icon (glyph code U+E78C)-
icon-sparklessparkles icon (glyph code U+E78D)-
icon-a-facemaskfillfacemask.fill icon (glyph code U+E78E)-
icon-a-wave3backwardcirclefillwave.3.backward.circle.fill icon (glyph code U+E78F)-
icon-a-wave3leftcirclefillwave.3.left.circle.fill icon (glyph code U+E790)-
icon-a-wandandstarsinversewand.and.stars.inverse icon (glyph code U+E791)-
icon-a-wave3rightcirclefillwave.3.right.circle.fill icon (glyph code U+E792)-
icon-xmarkxmark icon (glyph code U+E793)-
icon-a-wave3rightwave.3.right icon (glyph code U+E794)-
icon-a-waveformandmicwaveform.and.mic icon (glyph code U+E795)-
icon-a-wifiexclamationmarkwifi.exclamationmark icon (glyph code U+E796)-
icon-wifiwifi icon (glyph code U+E797)-
icon-a-xmarkicloudfillxmark.icloud.fill icon (glyph code U+E798)-
icon-windwind icon (glyph code U+E799)-
icon-timertimer icon (glyph code U+E79A)-
icon-a-wrenchandscrewdriverfillwrench.and.screwdriver.fill icon (glyph code U+E79B)-
icon-a-wave3forwardcirclefillwave.3.forward.circle.fill icon (glyph code U+E79C)-
icon-a-lockfilllock.fill icon (glyph code U+E79D)-
icon-a-wifislashwifi.slash icon (glyph code U+E79E)-
icon-a-windsnowwind.snow icon (glyph code U+E79F)-
icon-a-wave3forwardwave.3.forward icon (glyph code U+E7A0)-
icon-cancelCancel icon (glyph code U+E6EA)-
icon-a-arrowbackwardarrow.backward icon (glyph code U+E6EB)-
icon-a-arrowdownarrow.down icon (glyph code U+E6EC)-
icon-alarmalarm icon (glyph code U+E6ED)-
icon-a-alarmfillalarm.fill icon (glyph code U+E6EE)-
icon-a-airplanedepartureairplane.departure icon (glyph code U+E6EF)-
icon-a-arrowlefttolinealtarrow.left.to.line.alt icon (glyph code U+E6F0)-
icon-a-arrowforwardarrow.forward icon (glyph code U+E6F1)-
icon-airplaneairplane icon (glyph code U+E6F2)-
icon-a-arrow2squarepatharrow.2.squarepath icon (glyph code U+E6F3)-
icon-a-antennaradiowavesleftandrightantenna.radiowaves.left.and.right icon (glyph code U+E6F4)-
icon-a-arrowshapeturnuprightfillarrowshape.turn.up.right.fill icon (glyph code U+E6F5)-
icon-a-arrowcounterclockwisearrow.counterclockwise icon (glyph code U+E6F6)-
icon-a-arrowturndownleftarrow.turn.down.left icon (glyph code U+E6F7)-
icon-a-arrowturnupleftarrow.turn.up.left icon (glyph code U+E6F8)-
icon-a-airplanearrivalairplane.arrival icon (glyph code U+E6F9)-
icon-a-boltfillbolt.fill icon (glyph code U+E6FA)-
icon-a-arrowturnrightuparrow.turn.right.up icon (glyph code U+E6FB)-
icon-a-arrowcounterclockwiseicloudfillarrow.counterclockwise.icloud.fill icon (glyph code U+E6FC)-
icon-a-bellfillbell.fill icon (glyph code U+E6FD)-
icon-a-arrowupanddownandarrowleftandrightarrow.up.and.down.and.arrow.left.and.right icon (glyph code U+E6FE)-
icon-a-beddoublefillbed.double.fill icon (glyph code U+E6FF)-
icon-a-arrowshapeturnupleft2fillarrowshape.turn.up.left.2.fill icon (glyph code U+E700)-
icon-a-arrowtrianglerightfillandlineverticalandarrarrowtriangle.right.fill.and.line.vertical.and.arr icon (glyph code U+E701)-
icon-a-bolthorizontalicloudfillbolt.horizontal.icloud.fill icon (glyph code U+E702)-
icon-a-boltheartfillbolt.heart.fill icon (glyph code U+E703)-
icon-a-arrowupleftanddownrightandarrowuprightanarrow.up.left.and.down.right.and.arrow.up.right.an icon (glyph code U+E704)-
icon-a-arrowclockwiseicloudfillarrow.clockwise.icloud.fill icon (glyph code U+E705)-
icon-a-arrowupbackwardandarrowdownforwardarrow.up.backward.and.arrow.down.forward icon (glyph code U+E706)-
icon-a-arrowturndownrightarrow.turn.down.right icon (glyph code U+E707)-
icon-boldbold icon (glyph code U+E708)-
icon-a-arrowleftarrowrightarrow.left.arrow.right icon (glyph code U+E709)-
icon-a-bolthorizontalfillbolt.horizontal.fill icon (glyph code U+E70A)-
icon-checkmarkcheckmark icon (glyph code U+E70B)-
icon-a-arrowrighttolinealtarrow.right.to.line.alt icon (glyph code U+E70C)-
icon-a-bubblerightfillbubble.right.fill icon (glyph code U+E70D)-
icon-checkmark-2checkmark-2 icon (glyph code U+E70E)-
icon-clockclock icon (glyph code U+E70F)-
icon-a-carfillcar.fill icon (glyph code U+E710)-
icon-a-backwardendaltfillbackward.end.alt.fill icon (glyph code U+E711)-
icon-checkmark-4checkmark-4 icon (glyph code U+E712)-
icon-a-chevronright2chevron.right.2 icon (glyph code U+E713)-
icon-a-cloudboltrainfillcloud.bolt.rain.fill icon (glyph code U+E714)-
icon-a-bolthorizontalcirclefillbolt.horizontal.circle.fill icon (glyph code U+E715)-
icon-a-chevronleft2chevron.left.2 icon (glyph code U+E716)-
icon-a-chevroncompactdownchevron.compact.down icon (glyph code U+E717)-
icon-a-briefcasefillbriefcase.fill icon (glyph code U+E718)-
icon-a-arrowturnuprightarrow.turn.up.right icon (glyph code U+E719)-
icon-a-cloudboltfillcloud.bolt.fill icon (glyph code U+E71A)-
icon-a-cloudfillcloud.fill icon (glyph code U+E71B)-
icon-a-bubbleleftandbubblerightfillbubble.left.and.bubble.right.fill icon (glyph code U+E71C)-
icon-a-bellbadgefillbell.badge.fill icon (glyph code U+E71D)-
icon-checkmark-1checkmark-1 icon (glyph code U+E71E)-
icon-a-cloudmoonrainfillcloud.moon.rain.fill icon (glyph code U+E71F)-
icon-a-chevroncompactrightchevron.compact.right icon (glyph code U+E720)-
icon-a-crossfillcross.fill icon (glyph code U+E721)-
icon-a-busfillbus.fill icon (glyph code U+E722)-
icon-a-arrowturnleftuparrow.turn.left.up icon (glyph code U+E723)-
icon-a-cloudmoonboltfillcloud.moon.bolt.fill icon (glyph code U+E724)-
icon-a-arrowtriangleleftfillandlineverticalandarroarrowtriangle.left.fill.and.line.vertical.and.arro icon (glyph code U+E725)-
icon-a-checkmarkicloudfillcheckmark.icloud.fill icon (glyph code U+E726)-

Examples

Basic usage

import React from 'react';
import { View } from '@ray-js/ray';
import { Icon } from '@ray-js/icons';

export default function Demo() {
  return (
    <View style={{ padding: 20, flexDirection: 'row', gap: 15 }}>
      <Icon type="icon-right" size={24} />
      <Icon type="icon-warning" size={24} />
      <Icon type="icon-checkmark" size={24} />
      <Icon type="icon-cancel" size={24} />
    </View>
  );
}

Custom size

import React from 'react';
import { View } from '@ray-js/ray';
import { Icon } from '@ray-js/icons';

export default function Demo() {
  return (
    <View style={{ padding: 20, flexDirection: 'row', alignItems: 'center', gap: 15 }}>
      <Icon type="icon-right" size={16} color="#007aff" />
      <Icon type="icon-right" size={24} color="#007aff" />
      <Icon type="icon-right" size={32} color="#007aff" />
      <Icon type="icon-right" size={48} color="#007aff" />
    </View>
  );
}

Custom color

import React from 'react';
import { View } from '@ray-js/ray';
import { Icon } from '@ray-js/icons';

export default function Demo() {
  return (
    <View style={{ padding: 20, flexDirection: 'row', gap: 15 }}>
      <Icon type="icon-warning" size={30} color="#ff4d4f" />
      <Icon type="icon-checkmark" size={30} color="#52c41a" />
      <Icon type="icon-a-cloudrainfill" size={30} color="#1890ff" />
      <Icon type="icon-a-cloudsleetfill" size={30} color="#722ed1" />
    </View>
  );
}

Effect