Skip to main content

@barocss/office-icons

Version in this checkout: 0.1.2. npm · Source

Shared named icons for Office controls and product interfaces.

Purpose​

Use Icon instead of importing a separate icon library in each product. Named icons can also be checked by conformance tooling.

Install​

npm install @barocss/office-icons react react-dom

The published package provides ES modules and TypeScript declarations. Use a bundler that supports package exports.

Public entry points​

ImportRole
@barocss/office-iconsPublic JavaScript and TypeScript API

Import only these public paths. Source paths such as @barocss/office-icons/src/... are not part of the published API.

Usage​

import { Icon } from '@barocss/office-icons';

export function BoldButton() {
  return <button type="button" aria-label="Bold">
    <Icon name="bold" size={16} />
  </button>;
}

Peer dependencies​

  • react: >=18.
  • react-dom: >=18.

Integration notes​

Icons are decorative SVGs. Give the parent button or control an accessible name. Use names exported by the icon catalogue; an unknown name is not a substitute for a defined product action.

Documentation​

License​

MIT. The published archive includes the license in dist/LICENSE.