Skip to content

Latest commit

 

History

History
165 lines (125 loc) · 4.56 KB

README.md

File metadata and controls

165 lines (125 loc) · 4.56 KB

@openproject/octicons-angular

npm version

Install

npm install @openproject/octicons-angular

Usage

Angular component

The @openproject/octicons-angular module exports standalone components as named exports. This allows you to import only the icons that you need without blowing up your bundle:

import { Component } from '@angular/core';
import { LogIconComponent } from '@openproject/octicons-angular';

@Component({
  imports: [
    LogIconComponent,
  ],
  template: `<svg log-icon></svg>`,
})
export class MyComponent {}

In the code you simply use an svg tag with the name as attribtue. E.g:

<svg log-icon></svg>

Vertical alignment

By default the octicons have vertical-align: text-bottom; applied as inline styles. You can change the alignment via the verticalAlign input, which can be either middle, text-bottom, text-top, or top.

<svg
  log-icon
  vertical-align="text-bottom"  
></svg>

aria-label

You have the option of adding accessibility information to the icon with the aria-label attribute via the aria-label input.

<svg
  log-icon
  aria-label="Look at the logs"  
></svg>

aria-labelledby

You have the option of adding accessibility information to the icon with the aria-labelledby attribute via the aria-labelledby input. Using aria-labelledby referencing the id values of the title element provides the accessible name.

<svg
  log-icon
  aria-labelledby="title"  
  title="Look at the logs"  
></svg>

title

You have the option of adding accessibility information to the icon with the title attribute via the title input.

id

You have the option of adding information to the icon with the id attribute via the id input.

<svg
  log-icon
  id="unique-log-icon"  
></svg>

tabIndex

You can add the tabindex attribute to an SVG element via the tabIndex input if the SVG element is intended to be interactive. tabIndex input also controls the focusable attribute of the SVG element which is defined by SVG Tiny 1.2 and only implemented in Internet Explorer and Microsoft Edge.

If there is no tabIndex input is present (default behavior), it will set the focusable attribute to false. This is helpful for preventing the decorative SVG from being announced by some specialized assistive technology browsing modes which can get delayed while trying to parse the SVG markup.

<svg
  log-icon
  aria-label="Interactive log icon"  
  [tabIndex]="0" 
></svg>

Sizes

The size input takes small, medium, and large values that can be used to render octicons at standard sizes:

Prop Rendered Size
size='small' 16px height by computed width
size='medium' 32px height by computed width
size='large' 64px height by computed width 
<svg
  log-icon
  size="small"  
></svg>

Fill

The fill input takes a string value that can be used to set the color of the icon. By default, fill is set to currentColor.

<svg
  log-icon
  fill="#f00"  
></svg>

Dom string rendering

Alternatively, you can render an icon SVG directly, for example in legacy jQuery code:

import { logIconData, toDOMString } from '@openproject/octicons-angular';

const mySVGString:string = toDOMString(
  logIconData, // SVG data for the icon. You can get this by importing `${name}IconData`
  'small', // The icon size. Optional
  { 'aria-hidden': 'true' }, // Extra attributes like class, style, aria, and others. Optional.
);
document.body.innerHTML = mySVGString;