fluentui-system-icons README

The project's README from github.com/microsoft/fluentui-system-icons. As one markdown file: README.md.

Fluent UI System Icons

Pull request validation

Fluent UI System Icons are a collection of familiar, friendly and modern icons from Microsoft.

Fluent System Icons

Icon List

Direction

Within the metadata.json file for an icon, a property named directionType is used to indicate the direction of the icon. This property can have one of the following values:

The property singleton is also used to indicate the default direction that should be used for the icon.

Installation

Android

The library is published via Maven Central, please ensure that the mavenCentral() repository has been added to the root build.gradle file:

repositories {
    ...
    mavenCentral()
}

Include the following dependency in your project's build.gradle:

implementation 'com.microsoft.design:fluent-system-icons:1.1.341@aar'

For library docs, see android/README.md.

iOS and macOS

CocoaPods

use_frameworks!

pod "FluentIcons", "1.1.341"

Carthage

git "[email protected]:microsoft/fluentui-system-icons.git" "1.1.341"

For library docs, see ios/README.md.

Flutter

In the pubspec.yaml of your flutter project, add the following dependency:

dependencies:
  ...
  fluentui_system_icons: ^1.1.341

For library docs, see flutter/README.md.

Plain svg

Inline svg directly. See packages/svg-icons/README.md.

Contributing

Importer

The importer generates the Android and iOS libraries from the icons in the assets directory.

Install dependencies from the repository root (this is a single yarn workspace, so dependencies for every package are installed in one go):

corepack enable
yarn install

Jump into the directory:

cd importer
yarn clean

List all the available commands:

yarn run

Build Pipeline

Our build pipeline runs deploy:android and deploy:ios to create the libraries. The build definitions are located in .github/workflows/.

Demo apps

You can build and run the demo apps following the steps below.

Android

  1. Follow the Importer section above and run the command yarn deploy:android
  2. Open the android directory in Android Studio
  3. Select the sample-showcase in the build configuration dropdown
  4. Click run

Flutter

Prerequisite: Make sure you have flutter configured in Android Studio

  1. Open the flutter directory in Android Studio
  2. Select the example in the directory and open it in Android Studio
  3. Click run

Contact

Please feel free to open a GitHub issue and assign to the following points of contact with questions or requests.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

fluentui-system-icons (microsoft/fluentui-system-icons)

Searching Database…

10.9K ·GitHub
Fluentui-system-icons
Что это такое?Fluent UI System Icons — это открытая коллекция Microsoft: знакомые, дружелюбные и современные иконки, которые поставляются в виде готовых пакетов для Android, iOS/macOS и Flutter, а также в виде обычных SVG-файлов.
Это один набор иконок или отдельная библиотека для каждой платформы?Набор иконок общий, но подключается он отдельными пакетами: Maven-библиотека для Android, поды через CocoaPods или Carthage для iOS и macOS, пакет для Flutter и исходные SVG-файлы.
Как добавить иконки в своё приложение?Зависит от платформы: добавьте зависимость в Android build.gradle (пакет опубликован на Maven Central), установите под через CocoaPods или Carthage на iOS/macOS, добавьте его в pubspec.yaml во Flutter или вставьте SVG прямо в код.
Иконки работают в языках с письмом справа налево?Да, и для каждой иконки указано, как именно: в metadata.json есть поле directionType, где 'unique' означает отдельные версии для RTL и LTR, 'mirror' — что иконку просто отражают, а свойство singleton задаёт направление по умолчанию.
Библиотеки подходят и для веба, или только для мобильных и десктопных приложений?Нативные пакеты нацелены на Android, iOS и macOS, пакет для Flutter работает везде, где работает Flutter, а без всякого пакетного менеджера SVG-файлы можно вставить куда угодно, включая веб-страницы.
В каких стилях есть иконки?Два варианта: обычный (regular) и заполненный (filled), полные списки иконок каждого стиля можно посмотреть по ссылкам в README.
Можно ли попробовать иконки, прежде чем добавлять их в приложение?Да — в репозитории есть демо-приложения. Соберите Android-версию командой yarn deploy:android и запустите sample-showcase в Android Studio, либо откройте и запустите Flutter-пример.
Как из исходников иконок получаются библиотеки для Android и iOS?Импортер на yarn-workspace генерирует их из иконок в каталоге assets, а CI запускает deploy:android и deploy:ios; описания сборок лежат в .github/workflows/.
What are similar projects?material-design-icons, react-native-ui-kitten, fluentui, Best-Flutter-UI-Templates, simple-icons, heroicons, MaterialDesign, Font-Awesome
Which topics is it in?fluent, icon-pack, icons, android-library, flutter, design-system, microsoft, svg, design, swift, html, mobile
Creator
microsoft
Size
870.4 MB
Stars
10.9K
Updated
CommitOct 09
Age
6y
Commits · 90 Days