---
title: Iconset
description: Iconset
element: vaadin-iconset
---

## Description

`<vaadin-iconset>` is a Web Component for creating SVG icon collections.

## Properties

### name

**Type:** `string`

The name of the iconset. Every iconset is required to have its own unique name.
All the SVG icons in the iconset must have IDs conforming to its name.

See also [`name`](/elements/vaadin-icon#name) property of `vaadin-icon`.

### size

**Type:** `number`

The size of an individual icon. Note that icons must be square.

When using `vaadin-icon`, the size of the iconset will take precedence
over the size defined by the user to ensure correct appearance.

## Static Methods

### getIconset

**Type:** `(name: string) => Iconset`

Returns an instance of the iconset by its name.

### getIconSvg

**Type:** `(icon: string, name?: string | undefined) => { preserveAspectRatio?: string | null | undefined; svg: IconSvgLiteral; size?: number | undefined; viewBox?: string | null | undefined; }`

Returns SVGTemplateResult for the `icon` ID matching `name` of the
iconset, or `nothing` literal if there is no matching icon found.

### register

**Type:** `(name: string, size: number, template: HTMLTemplateElement) => void`

Register an iconset without adding to the DOM.

