Loading Icon

Loading icons are used as an indicator of an event in progress.

Overview

Loading icons are used to indicate to users that an event is ocurring and is still in progress. They should only be used for short loading processes. For events that can take a considerable amount of time, use the Progress Bar component instead.

Usage

Within a standalone component

To use loading icon in a standalone component, import it directly into your custom component:

@Component({
  selector: 'custom-component',
  templateUrl: './custom-component.component.html',
  standalone: true,
  imports: [
    DAFF_LOADING_ICON_COMPONENTS,
  ],
})
export class CustomComponent {}

Within a module (deprecated)

To use loading icon in a module, import DaffLoadingIconModule into your custom module:

import { NgModule } from '@angular/core';

import { DaffLoadingIconModule } from '@daffodil/design/loading-icon';

@NgModule({
    declarations: [
    CustomComponent,
  ],
  exports: [
    CustomComponent,
  ],
  imports: [
    DaffLoadingIconModule,
  ],
})
export class CustomComponentModule { }

This method is deprecated. It's recommended to update all custom components to standalone.

Theming

The loading icon color is defined by using the color property. By default, the color is set to primary. This can be changed to one of the supported colors.

Supported colors: primary | secondary | tertiary | black | white | theme | theme-contrast

Accessibility

Loading icons should be given meaningful labels by using aria-label or aria-labelledby. Additionally, if a loading icon is used to indicate a process in progress, using aria-live and aria-busy should be strongly considered.

Graycore, LLC © 2018 - 2024. Code licensed under an MIT-style License. Documentation licensed under CC BY 4.0.