{"repo":"box-icons/boxicons","free":true,"listed":false,"github":"https://github.com/box-icons/boxicons","clone":"git clone https://github.com/box-icons/boxicons.git","description":"High Quality web friendly icons","language":"TypeScript","stars":3183,"topics":["icons","svg-icons","svg","icon-font","icon-pack"],"license":"MIT","category":"ui-components","readme_excerpt":"@boxicons/js JavaScript library for Boxicons with full tree-shaking support. Inspired by Lucide. Installation Usage With ESModules (Recommended) To reduce bundle size, @boxicons/js is built to be fully tree-shakable. The getIcons function will search for HTMLElements with the attribute data-bx and replace them with the SVG from the given icon name. With unpkg (CDN) Custom Element Binding Custom Element Binding with Custom Attributes Advanced Usage Additional Options In the getIcons function you can pass some extra parameters: - nameAttr - adjust the attribute name to look for (default: data-bx ) - attrs - pass additional custom attributes to all icons - root - provide a custom DOM element or shadow root to search within - inTemplates - also replace icons inside tags Shadow DOM Support You can use icons inside Shadow DOM by passing the shadow root as the root option: Template Tags Support To replace icons inside tags, set inTemplates: true : Icon Packs Each icon can have multiple variants: - basic - Outline/regular style icons (default for most icons) - filled - Solid/filled style icons - brands - Brand/logo icons (default for brand icons) Sizing Size Presets Custom Sizing Transformations Styling Programmatic Usage Accessibility By default, icons are hidden from screen readers using aria-hidden=\"true\" . You can add accessibility attributes using aria-labels: API Reference Core Functions Function Description ---------- ------------- getIcons(options) Scan DOM for data-bx elemen","default_branch":null,"files":null,"tree":[],"storefront":"/r/box-icons","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/box-icons/boxicons/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}