Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DS-736: Element Icon JS Docs #2514

Merged
merged 3 commits into from
Jul 15, 2022
Merged

DS-736: Element Icon JS Docs #2514

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81c7e57
ds-736 first pass at icon js docs
cjwhitedev Jul 11, 2022
43f6076
DS-736 formatting changes
cjwhitedev Jul 14, 2022
2922c8e
DS-736: Update JS docs
danielamorse Jul 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs-site/src/pages/pattern-lab/_patterns/20-elements/icon/25-icon-javascript-usage.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{% set description %}
<bolt-ol>
<bolt-li>Import icons individually: <code>import { iconChevronDown } from '@bolt/elements-icon/src/icons/js/chevron-down';</code>. Importing icons individually reduces the compiled JS file size.</bolt-li>
<bolt-li>The imported icon is a function that returns an <code>&lt;svg&gt;</code> element as a string. It automatically includes the <code>e-bolt-icon</code> class on the SVG. The function accepts a JSON object as an argument. It supports the same props as the Icon element, for example: <code>chevronDown({ size: 'xsmall', class: 'u-bolt-margin-right-xsmall' })</code>.</bolt-li>
<bolt-li>If you are using a web component, wrap the icon in <code>unsafeHTML()</code> as follows: <code>${unsafeHTML(iconChevronDown())}</code>.</bolt-li>
</bolt-ol>
{% endset %}

{% set code_snippet %}
import { html, unsafeHTML } from '@bolt/element';
import { iconChevronDown } from '@bolt/elements-icon/src/icons/js/chevron-down';

return html`
<div class="c-bolt-accordion-item__trigger-icons-inner">
${unsafeHTML(iconChevronDown())}
</div>
`;
{% endset %}

{% set notes %}
A real-world example can currently be found in <em>AccordionItemTrigger.js</em>, shown in an altered demo below.

<div class="c-bolt-code-snippet" data-lang="js" data-mode="light">
<pre><code>{{ code_snippet|trim }}</code></pre>
</div>
{% endset %}

{% include '@utils/pattern-doc-page.twig' with {
title: 'Icon Javascript Use',
description: description,
notes: notes,
} only %}