Skip to content

Commit

Permalink
docs(icons): drop content to only mention Solaris
Browse files Browse the repository at this point in the history
  • Loading branch information
ffoodd committed Oct 13, 2020
1 parent 9519332 commit 90af24b
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 56 deletions.
2 changes: 1 addition & 1 deletion config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ params:
rfs_version: "9.0.3"
repo: "https:/Orange-OpenSource/Orange-Boosted-Bootstrap"
twitter: "orange"
icons: "https://icons.getbootstrap.com/"
icons: "https://design.orange.com/icons-libraries/"

download:
source: "https:/Orange-OpenSource/Orange-Boosted-Bootstrap/archive/v5.0.0-alpha2.zip"
Expand Down
2 changes: 1 addition & 1 deletion scss/_alert.scss
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
// Boosted mod
//

//// Only border changes — and we add an icon
//// Only border changes — and we add a Solaris icon

// scss-docs-start alert-modifiers
// Generate contextual modifier classes for colorizing the alert.
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.0/components/toasts.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ When you have multiple toasts, we default to vertically stacking them in a reada

### Custom content

Customize your toasts by removing sub-components, tweaking with [utilities]({{< docsref "/utilities/api" >}}), or adding your own markup. Here we've created a simpler toast by removing the default `.toast-header`, adding a custom hide icon from [Bootstrap Icons]({{< param icons >}}), and using some [flexbox utilities]({{< docsref "/utilities/flex" >}}) to adjust the layout.
Customize your toasts by removing sub-components, tweaking with [utilities]({{< docsref "/utilities/api" >}}), or adding your own markup. Here we've created a simpler toast by removing the default `.toast-header`, adding a custom hide icon from [Bootstrap Icons](https://icons.getbootstrap.com), and using some [flexbox utilities]({{< docsref "/utilities/flex" >}}) to adjust the layout.

{{< example class="bg-light" >}}
<div class="toast d-flex align-items-center" role="alert" aria-live="assertive" aria-atomic="true">
Expand Down
34 changes: 6 additions & 28 deletions site/content/docs/5.0/extend/icons.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,18 @@
---
layout: docs
title: Icons
description: Guidance and suggestions for using external icon libraries with Boosted.
description: Guidance and suggestions for using Solaris icon libraries with Boosted.
group: extend
---

While Boosted doesn't include an icon set by default, we do have our own comprehensive icon library called Bootstrap Icons. Feel free to use them or any other icon set in your project. We've included details for Bootstrap Icons and other preferred icon sets below.
While Boosted doesn't include an icon set by default, Orange does have its own comprehensive icon library called Solaris.

While most icon sets include multiple file formats, we prefer SVG implementations for their improved accessibility and vector support.

## Bootstrap Icons
## Solaris

Bootstrap Icons is a growing library of SVG icons that are designed by [@mdo](https:/mdo) and maintained by [the Bootstrap Team](https://github.com/orgs/twbs/people). The beginnings of this icon set come from Bootstrap's very own components—our forms, carousels, and more. Boosted has very few icon needs out of the box, so we didn't need much. However, once we got going, we couldn't stop making more.
Solaris is a growing library of SVG icons that are designed by [Orange's Global Design Language Team](https://design.orange.com/).

Oh, and did we mention they're completely open source? Licensed under MIT, just like Bootstrap, our icon set is available to everyone.
They are not open-source though and should only be used for Orange branded projects. Please refer to our [`NOTICE.txt` file for legal informations]({{< param repo >}}/blob/v{{< param current_version >}}/NOTICE.txt).

[Learn more about Bootstrap Icons]({{< param icons >}}), including how to install them and recommended usage.

## Alternatives

We've tested and used these icon sets ourselves as preferred alternatives to Bootstrap Icons.

{{< markdown >}}
{{< icons.inline >}}
{{- $type := .Get "type" | default "preferred" -}}

{{- range (index .Site.Data.icons $type) }}
- [{{ .name }}]({{ .website }})
{{- end }}
{{< /icons.inline >}}
{{< /markdown >}}

## More options

While we haven't tried these out ourselves, they do look promising and provide multiple formats, including SVG.

{{< markdown >}}
{{< icons.inline type="more" />}}
{{< /markdown >}}
[Learn more about Solaris]({{< param icons >}}) (requires an `@orange.com` email to sign-up).
25 changes: 0 additions & 25 deletions site/data/icons.yml

This file was deleted.

0 comments on commit 90af24b

Please sign in to comment.