Icons

How to integrate icons in CodyFrame.

Set your custom icon options in the 📁 custom-style/_icons.scss file.

🔍 On this page:

1. .icon Class
2. Sizes
3. Off-Scale Values
4. Align Icons and Text
5. Integrate your Icons
6. Other Classes

.icon Class #

The .icon class is used to set the basic style for all icons. Make sure to add this class to all your icon elements.

.icon {
  --size: 1em;
  display: inline-block;
  color: inherit; // icons inherit the text color
  fill: currentColor;
  height: var(--size);
  width: var(--size);
  line-height: 1;
  flex-shrink: 0;
  max-width: initial;
}

If you are using an icon font, make sure to include the font-family inside the 📁 custom-style/_icons.scss file:

.icon {
  font-family: 'fontName';
}

Sizes #

CodyFrame includes a default icon size scale. Optionally, you can set a custom size scale in the 📁 custom-style/_icons.scss file:

:root {
  // default icon sizes
  --icon-xxxs: 8px;
  --icon-xxs:  12px;
  --icon-xs:   16px;
  --icon-sm:   24px;
  --icon-md:   32px;
  --icon-lg:   48px;
  --icon-xl:   64px;
  --icon-xxl:  96px;
  --icon-xxxl: 128px;
}

To change the icon size, use one of the custom properties above in CSS, or the following utility classes:

Example:

<svg class="icon icon--sm" viewBox="0 0 16 16">
  <!-- ... -->
</svg>

An alternative approach would be to create a list of size utility classes in pixels and add them to the 📁 custom-style/_util.scss file:

// --------------------------------

// Size

// --------------------------------

.size-8   { height: 8px; width: 8px; }
.size-10  { height: 10px; width: 10px; }
.size-12  { height: 12px; width: 12px; }
.size-16  { height: 16px; width: 16px; }
.size-20  { height: 20px; width: 20px; }
.size-24  { height: 24px; width: 24px; }
.size-32  { height: 32px; width: 32px; }
.size-48  { height: 48px; width: 48px; }
.size-64  { height: 64px; width: 64px; }
.size-96  { height: 96px; width: 96px; }

Here's how to set the icon size if you decide to include the above classe:

<svg class="icon size-16" viewBox="0 0 16 16">
  <!-- ... -->
</svg>

Off-Scale Values #

The size of the .icon component is set using the --size custom property:

.icon {
  --size: 1em;
  height: var(--size);
  width: var(--size);
  // ...
}

To set off-scale values, you can modify the value of the --size variable inline:

<svg class="icon" style="--size: 20px;" viewBox="0 0 16 16">
  <!-- ... -->
</svg>

Aligning Icons with Text #

To align icons and text, you can use the flexbox utility classes. Because the default size of the .icon component is 1em, the icon size is equal to the current font-size:

To create custom bullets for your list items, you can use the list component.

Integrate your Icons #

There are multiple options when it comes to integrating icons into your design system (SVG Sprites, inline SVG, SVG symbols, icon fonts...). You can pick whatever method you prefer, they are all compatible with CodyFrame.

If you're not sure about which method to choose, take a look at this article on integrating and styling icon systems.

Other Classes #

Other icon classes:

If you're using inline SVG icons, you can use the SVG utility classes: