Back to PrimitivesView on GitHub
Icon
1:1MediaPolaris icon from the built-in set.
Example
Usage
import { Icon } from '@/components/polaris';
function Example() {
return (
<div style={{ display: 'flex', gap: 8 }}>
<Icon name="product" />
<Icon name="order" />
<Icon name="settings" />
</div>
);
}Component Source
import { forwardRef, createElement } from 'react';
import type { JSX } from 'react';
export type IconProps = JSX.IntrinsicElements['s-icon'];
/**
* Icon component - displays icons from the Polaris icon set.
*
*
* @example
* <Icon name="search" />
* <Icon name="check" tone="success" />
*/
export const Icon = forwardRef<HTMLElement, IconProps>((props, ref) => {
return createElement('s-icon', { ref, ...props });
});
Icon.displayName = 'Icon';