# CircleIcon

# Most common usage scenario


This section is not fully documented yet. We are doing our best to make our documentation a good and complete source of knowledge about Storefront UI. If you would like to help us, please don't hesitate to contribute to our docs. You can read more about it here.

# Props

  • icon

    • type: string|array
    • defaultValue: "home"
  • colorIcon

    • type: string
    • defaultValue: "white"
  • sizeIcon

    • type: string
    • defaultValue: "100%"

# Slots

  • default
    • Custom content that will replace default icon. can be used for inlined SVG's

# Events


# CSS modifiers

  • .sf-circle-icon--small
  • .sf-circle-icon--big

# SCSS variables

$circle-icon-background-primary: $c-green-primary !default;
$circle-icon-background-secondary: $c-dark-primary !default;
$circle-icon-icon-color: $c-white !default;
$circle-icon-size: 3.25rem !default;
$circle-icon-size-small: 1.625rem !default;
$circle-icon-size-big: 4rem !default;

You can override SCSS variable values bound to this component in sfui.scss in the root of your project.

# Partials

If you want to customize this component even more you can use its partials for limitless customization.

<template lang="html" src="@storefront-ui/vue/src/components/atoms/SfCircleIcon/SfCircleIcon.html"></template>
<script src="@storefront-ui/vue/src/components/atoms/SfCircleIcon/SfCircleIcon.js"></script>
<style lang="scss">
@import "~@storefront-ui/shared/styles/components/SfCircleIcon.scss";

You can read about using component partials here

# Play with this component

See all available configurations and play with this component on Storybook.