GridIconRegistry

Injectable service for managing grid icons.

Use provideGridIcons() in your app config to set up icons, or inject this service for dynamic registration.

Example

// App-level setup (app.config.ts)
export const appConfig: ApplicationConfig = {
  providers: [
    provideGridIcons({
      expand: '➕',
      collapse: '➖',
      sortAsc: '↑',
      sortDesc: '↓',
    })
  ]
};

// Dynamic registration
@Component({ ... })
export class AppComponent {
  private registry = inject(GridIconRegistry);

  ngOnInit() {
    this.registry.set('filter', '<svg>...</svg>');
  }
}

Methods

set()

Set an icon override.

set(name: K, value: unknown): void

Parameters

Name	Type	Description
name	K	The icon name (e.g., ‘expand’, ‘collapse’, ‘filter’)
value	unknown	The icon value (string text or SVG markup)

---

get()

Get an icon value.

get(name: K): unknown | undefined

Parameters

Name	Type	Description
name	K

---

remove()

Remove an icon override.

remove(name: unknown): void

Parameters

Name	Type	Description
name	unknown

---

has()

Check if an icon has an override.

has(name: unknown): boolean

Parameters

Name	Type	Description
name	unknown

---

getAll()

Get all icon overrides as a GridIcons partial. Used internally by the adapter.

getAll(): Partial<GridIcons>

---

getRegisteredIcons()

Get all registered icon names.

getRegisteredIcons(): unknown[]

---