Icon | Abyss

Icon

import { Icon } from '@uhg-abyss/mobile';

size

title

color

() => {
  const customIcon = (
    `<svg viewBox="0 0 16 16">
      <path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z" />
    </svg>`
  );

  return (
    <Icon size={48} title="github">{customIcon}</Icon>
  );
};

Usage

Use Icon to implement custom SVG icons

Colors

Use the color property to adjust the color of a Google material icon. The default color is set to the theme 'interactive1'.

Size

Use the size property to adjust the size of an icon by setting it to a specific preset size or number. The default is set to 24px || $icon.sizing.md. The size prop can take in px or tokens. Token sizes: $icon.sizing.xs: 16 $icon.sizing.sm: 20 $icon.sizing.md: 24 $icon.sizing.lg: 40 $icon.sizing.xl: 48

Icon Props

Prop Name	Type	Default	Description
children	ReactNode	-	The svg content of the icon
color	string	$web.semantic.color.icon.interactive.rest.tertiary	Set the color of the icon
disableScaling	boolean	-	Specifies whether the icon should scale to respect Text Size accessibility settings
isScreenReadable	boolean	-	Indicate whether the icon is screen readable or not. If the icon is Screen Readable, then provide a title
maxFontSizeMultiplier	boolean	-	Specifies the largest possible scale the icon can reach when disableScaling is false
size	number \| string	24px	Set the size of the icon
title	string	-	Set the title of the icon

Icon Classes

Class Name	Description
abyss-icon-root	Icon root element

Search tokens

Icon Tokens

Token Name	Value
icon.color.default	#196ECF
icon.sizing.xs	16
icon.sizing.sm	20
icon.sizing.md	24
icon.sizing.lg	40
icon.sizing.xl	48

Usage​

Colors​

Size​