Giter Club home page Giter Club logo

react-svg-sprite's Introduction

Getting start

git clone <repo>
cd <directory>
npm install
npm run start
Переходим на https://localhost:8080/public_html

Структура

В файле src/svg-icons.js лежит коллекция иконок. Сами иконки представляют из себя объект вида:

{
    id: <string>,
    viewBox: <string>,
    source: <string>,
}

Для создание спрайта и добавления его в разметку используется компонент SvgSprite. Он принимает коллекцию иконок в свойство symbols.

<SvgSprite symbols={[{ ... }, ...]} />

На выходе получаем:

<svg style="display: block; width: 0; height: 0">
    <symbol id="..." viewBox="..."> ... </symbol>
    ...
</svg>

Для использование спрайта существует компонент SvgIcon, который принимает свойство name соотвествующий имени нужной иконки.

<SvgIcon name="<имя_иконки>" />

Компонент возвращает svg вида:

<svg class="icon icon_<имя_иконки>">
    <use xlink:href="#<имя_иконки>" />
</svg>

Features

  • автоматизация создания коллекции иконок (сейчас это нужно делать вручную)
  • добавление в разметку спрайта только с теми иконками, которые используются в данный момент и последующее динамическое добавление иконок в этот спрайт (чтобы не засорять разметку)

react-svg-sprite's People

Contributors

inomdzhon avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.