fluentui-system-icons/README.md

2.3 KiB

Fluent design icons

Fluent design icons is a set of mobile platform icons from Microsoft.

fluent design icons

Installation

Android

Add the microsoftdesign repository to your project's top level build.gradle:

repositories {
    maven {
        name 'vsts-maven-microsoftdesign'
        url 'https://pkgs.dev.azure.com/microsoftdesign/951975d5-69cc-4771-9d98-92a4b1a82b2b/_packaging/fluent-icons/maven/v1'
        credentials {
            username = [Your VSTS username]
            password = [Your VSTS access token]
        }
    }
    ...
}

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

implementation 'com.microsoft.design:fluent-icons:1.0.160'

For library docs, see android/README.md.

iOS

Cocoapods

pod "FluentIcons", git: "https://microsoftdesign@dev.azure.com/microsoftdesign/Design%20System/_git/fluent-mobile-icons", tag: "1.0.160"

Carthage

git "git@ssh.dev.azure.com:v3/microsoftdesign/Design%20System/fluent-mobile-icons" "1.0.160"

For library docs, see ios/README.md.

Contributing

Importer

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

Jump into the directory

cd importer

Install npm dependencies

npm install
npm run clean

List all the available commands

npm run

Build Pipeline

Our build pipeline runs deploy:android and deploy:ios to create the libraries. The build definitions are in azure-pipelines.yml and pipelines.

Run the demo apps

Android

  1. Open the android directory in Android Studio
  2. Select the sample-showcase in the build configuration dropdown
  3. Click run

iOS

  1. open ios/FluentIcons.xcworkspace/
  2. Product > Run

Contact

Please feel free to reach out to the following points of contact with questions or requests.