Skip to content

feat: six-icon now supports custom svgs #445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fortesp merged 4 commits into from
Jun 17, 2026
Merged

feat: six-icon now supports custom svgs #445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3b2a091
feat(six-icon): support custom SVGs
fortesp Jun 1, 2026
e126c11
chore(six-icon): regenerate wrappers and clean up demo
fortesp Jun 1, 2026
37b4eb1
fix(six-icon): rename demo svg and stop shipping it in dist
fortesp Jun 1, 2026
59a32ca
fix: package-lock.json
fortesp Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .idea/inspectionProfiles/Project_Default.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
## Upcoming

- `six-breadcrumbs` new style aligned with design guidelines. Added `size` interface property.
- `six-icon`: Support for custom SVGs via new `src` and `inline-svg` props.

## 5.4.0 - 2026-03-12

Expand Down
58 changes: 48 additions & 10 deletions docs/components/six-icon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ SIX UI Library supports Material **Icons** and **Symbols**. Browse: [Material Ic
<six-icon>pie_chart</six-icon>
<six-icon>settings</six-icon>
<six-icon>sick</six-icon>
<six-icon>fort</six-icon>
<six-icon>castle</six-icon>
<six-icon name="fort"></six-icon>
<six-icon name="castle"></six-icon>
</div>
```

Expand Down Expand Up @@ -201,24 +201,62 @@ The icons are available in different sizes. Default size is medium (24px).
```


#### Custom SVG

Comment thread
pennal marked this conversation as resolved.
<docs-demo-six-icon-12></docs-demo-six-icon-12>

```html
<div style="display: flex; gap: 1em; min-height: 6rem; align-items: center">
<six-icon size="xSmall" src="/assets/demo-icon.svg"></six-icon>
<six-icon size="small" src="/assets/demo-icon.svg"></six-icon>
<six-icon size="large" src="/assets/demo-icon.svg"></six-icon>
<six-icon size="xxLarge" src="/assets/demo-icon.svg"></six-icon>
</div>
```


#### Custom SVG inline

Comment thread
pennal marked this conversation as resolved.
<docs-demo-six-icon-13></docs-demo-six-icon-13>

```html
<div style="display: flex; gap: 1em; min-height: 6rem; align-items: center; fill: red">
<six-icon size="xSmall" src="/assets/demo-icon.svg" inline-svg></six-icon>
<six-icon size="small" src="/assets/demo-icon.svg" inline-svg></six-icon>
<six-icon size="large" src="/assets/demo-icon.svg" inline-svg></six-icon>
<six-icon size="xxLarge" src="/assets/demo-icon.svg" inline-svg></six-icon>
</div>
```



<!-- Auto Generated Below -->


## Properties

| Property | Attribute | Description | Type | Default |
| --------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------- |
| `filled` | `filled` | If set to true the default material outlined icons are not used. | `boolean` | `false` |
| `library` | `library` | Icon library to use when no `library` prop is provided. By default, all `<six-icon>` instances fall back to the globally configured default library (via `setDefaultIconLibrary()` / `getDefaultIconLibrary()`), which is `"material-icons"` unless changed at runtime. This allows teams to switch the default across an entire project without having to set the `library` prop on every `<six-icon>` instance. Icon library for this instance. Overrides the global default. - "material-icons" → Material Icons - "material-symbols" → Material Symbols | `"material-icons" \| "material-symbols" \| undefined` | `undefined` |
| `size` | `size` | The icon's size. | `"inherit" \| "large" \| "medium" \| "small" \| "xLarge" \| "xSmall" \| "xxLarge" \| "xxxLarge"` | `'inherit'` |
| Property | Attribute | Description | Type | Default |
| ----------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------- |
| `filled` | `filled` | If set to true the default material outlined icons are not used. | `boolean` | `false` |
| `inlineSvg` | `inline-svg` | If the src is a svg, either render <svg><use/></svg> or <img> - <svg><use/></svg> is better for styling (e.g. fill: red), but slower at rendering. - <img> is better for HTTP caching, but you cannot style the internal SVG elements. | `boolean` | `false` |
| `library` | `library` | Icon library for this instance. Overrides the global default. - "material-icons" → Material Icons - "material-symbols" → Material Symbols | `"material-icons" \| "material-symbols" \| undefined` | `undefined` |
| `name` | `name` | Name of the icon | `string \| undefined` | `undefined` |
| `size` | `size` | The icon's size. | `"inherit" \| "large" \| "medium" \| "small" \| "xLarge" \| "xSmall" \| "xxLarge" \| "xxxLarge"` | `'inherit'` |
| `src` | `src` | Path to SVG file or a data image | `string \| undefined` | `undefined` |


## Slots

| Slot | Description |
| ---- | -------------------------------------- |
| | Used to define the material icon name. |
| Slot | Description |
| ---- | --------------------------------------------------------------------------- |
| | Used to define the material icon or symbol name when `src` is not provided. |


## Shadow Parts

| Part | Description |
| ------- | ----------- |
| `"svg"` | |


## Dependencies
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/docs-demo-six-icon-0.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
<six-icon>pie_chart</six-icon>
<six-icon>settings</six-icon>
<six-icon>sick</six-icon>
<six-icon>fort</six-icon>
<six-icon>castle</six-icon>
<six-icon name="fort"></six-icon>
<six-icon name="castle"></six-icon>
</div>

</div>
Expand Down
21 changes: 21 additions & 0 deletions docs/examples/docs-demo-six-icon-12.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<template>
<div>

<div style="display: flex; gap: 1em; min-height: 6rem; align-items: center">
<six-icon size="xSmall" src="/assets/demo-icon.svg"></six-icon>
<six-icon size="small" src="/assets/demo-icon.svg"></six-icon>
<six-icon size="large" src="/assets/demo-icon.svg"></six-icon>
<six-icon size="xxLarge" src="/assets/demo-icon.svg"></six-icon>
</div>

</div>
</template>
<style>

</style>
<script>
export default {
name: 'docs-demo-six-icon-12',
mounted() { }
}
</script>
21 changes: 21 additions & 0 deletions docs/examples/docs-demo-six-icon-13.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<template>
<div>

<div style="display: flex; gap: 1em; min-height: 6rem; align-items: center; fill: red">
<six-icon size="xSmall" src="/assets/demo-icon.svg" inline-svg></six-icon>
<six-icon size="small" src="/assets/demo-icon.svg" inline-svg></six-icon>
<six-icon size="large" src="/assets/demo-icon.svg" inline-svg></six-icon>
<six-icon size="xxLarge" src="/assets/demo-icon.svg" inline-svg></six-icon>
</div>

</div>
</template>
<style>

</style>
<script>
export default {
name: 'docs-demo-six-icon-13',
mounted() { }
}
</script>
22 changes: 22 additions & 0 deletions docs/public/assets/demo-icon.svg
View file
Open in desktop
Comment thread
fortesp marked this conversation as resolved.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions libraries/ui-library-angular/src/lib/stencil-generated/components.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -851,14 +851,14 @@ export declare interface SixHeaderMenuButton extends Components.SixHeaderMenuBut


@ProxyCmp({
inputs: ['filled', 'library', 'size']
inputs: ['filled', 'inlineSvg', 'library', 'name', 'size', 'src']
})
@Component({
selector: 'six-icon',
changeDetection: ChangeDetectionStrategy.OnPush,
template: '<ng-content></ng-content>',
// eslint-disable-next-line @angular-eslint/no-inputs-metadata-property
inputs: ['filled', 'library', 'size'],
inputs: ['filled', 'inlineSvg', 'library', 'name', 'size', 'src'],
standalone: false
})
export class SixIcon {
Expand Down
3 changes: 3 additions & 0 deletions libraries/ui-library-vue/src/lib/stencil-generated/components.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,9 @@ export const SixHeaderMenuButton: StencilVueComponent<JSX.SixHeaderMenuButton> =


export const SixIcon: StencilVueComponent<JSX.SixIcon> = /*@__PURE__*/ defineContainer<JSX.SixIcon>('six-icon', undefined, [
'name',
'src',
'inlineSvg',
'size',
'filled',
'library'
Expand Down
Loading
Loading