Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Graph] Remove usages of font awesome #160232

Closed
35 of 38 tasks
stratoula opened this issue Jun 22, 2023 · 3 comments · Fixed by #162048
Closed
35 of 38 tasks

[Graph] Remove usages of font awesome #160232

stratoula opened this issue Jun 22, 2023 · 3 comments · Fixed by #162048
Assignees
@dej611
Labels
Feature:Graph Graph application feature impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Team:Visualizations Visualization editors, elastic-charts and infrastructure technical debt Improvement of the software architecture and operational architecture

Comments

@stratoula
Copy link
Contributor

stratoula commented Jun 22, 2023 •
edited by dej611
Loading

Describe the feature:
Part of #46410

In order to remove the font awesome library from Graph we need to find an alternative for the icons used.

With tick are the icons we have on EUI or Maki

  • Folder open = folderOpen
  • Cube = kubernetesPod
  • Key
  • Bank => maki museum
  • Automobile => maki car
  • Home = home
  • Question = questionInCircle
  • Plane => maki airplane
  • File open = document
  • User = user
  • Users = users
  • Music => maki music
  • Flag = flag
  • Tag = tag
  • Phone => maki telephone or mobile-phone
  • Desktop = desktop
  • Font = lettering
  • At
  • Heart = heart
  • Bolt = bolt
  • Map marker = mapMarker
  • Exclamation = warning
  • Industry => maki industry

Drill down icons:

  • Line chart => visLine
  • Pie chart => visPie
  • Area chart => visArea
  • Bar chart => visBarVertical
  • Globe => globe
  • File open = document
  • Google
  • Eye => eye
  • Tachometer => visGauge
  • Info => iInCircle
  • External link => link?
  • Table => tableDensityCompact / visTable
  • List => list
  • Share => share?

We want to first

  1. Check if we can use maki icons first (as maps do)
  2. If not, then we must create the missing icons in eui and use them instead
@stratoula stratoula added Feature:Graph Graph application feature technical debt Improvement of the software architecture and operational architecture Team:Visualizations Visualization editors, elastic-charts and infrastructure impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. labels Jun 22, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-graph (Feature:Graph)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-visualizations @elastic/kibana-visualizations-external (Team:Visualizations)

@stratoula stratoula mentioned this issue Jun 22, 2023
Closed
@dej611
Copy link
Contributor

dej611 commented Jun 28, 2023 •
edited
Loading

The only 3 icons I could not find on Maki are at, key and Google, which perhaps should be provided by EUI.
Meanwhile I'll put together a PoC with the FontAwesome removal

@dej611 dej611 mentioned this issue Jul 7, 2023
Closed
@dej611 dej611 mentioned this issue Jul 17, 2023
Merged
26 tasks
dej611 added a commit that referenced this issue Jul 20, 2023
@dej611 @MichaelMarcialis
[Graph] Replace Fontawesome with EUI + Maki icons (#162048)
d064bfe 
## Summary

Fixes #160232

This PR removes completely FontAwesome from the Graph plugin and replace
its usage with mostly EUI + few Maki icons.
As for the Google icon, @MichaelMarcialis do you think we should just
have a custom SVG icon within the Graph app?

Here's a list of the replaced icons, but if I forgot anything let me
know:

* [x] Created generic `IconRenderer` component to abstract away the
package type from the rendering
  * [x] Add logic for color switch based on background color
* Replace icons in graph visualization
  * [x] Replace with EUI icons
  * [x] Replace with Maki icons
  * [x] Add `prevName` to recover old saved graph SO
  * [x] Fix selection preview icon
* For the `at` and `key` icons it needs to wait for a new EUI release
with elastic/eui#6934
* Replace drill down icons 
  * [x] Replace with EUI icons
  * [x] Replace with Maki icons
  * [x] Find a substitute for Google icon
  * [x] Add `prevName` to recover old saved graph SO
* App toolbars
  * [x] Replace app toolbar icons with EUI icons
    * [x] Changed blocked list icon from `ban` to `filterIgnore`
  * [x] Replace styling icon + color swatches
    * The EUI `dot` icon was too small, so switches to rect icons 
  * [x] Replace merge icons on link selection
  * [x] Replace group/ungroup icons with `fold/unfold`
  * [x] Custom drilldowns
* [x] Removed `LegacyIcon`
  * Replaced usage in various places

New icons within field configuration + graph visualization

<img width="1061" alt="Screenshot 2023-07-17 at 11 00 35"
src="https://github.com/elastic/kibana/assets/924948/59f981e7-64b7-4ce5-b3ae-2582d46fc373">

<img width="302" alt="Screenshot 2023-07-17 at 15 13 04"
src="https://github.com/elastic/kibana/assets/924948/fb8d0e63-e982-406f-bd8d-036d71d37442">

New toolbar with blocked icon changed

<img width="202" alt="Screenshot 2023-07-17 at 15 13 40"
src="https://github.com/elastic/kibana/assets/924948/241206c4-7d3b-4296-bd6b-c2df3f3eabe5">

<img width="220" alt="Screenshot 2023-07-17 at 15 13 35"
src="https://github.com/elastic/kibana/assets/924948/5a648932-2f79-4c0e-a8d0-3ab165f68036">

<img width="272" alt="Screenshot 2023-07-17 at 12 41 12"
src="https://github.com/elastic/kibana/assets/924948/e3778d20-3000-496e-881b-61e5f086ae52">

New group/ungroup icons

<img width="168" alt="Screenshot 2023-07-17 at 12 41 25"
src="https://github.com/elastic/kibana/assets/924948/ffc963e6-4fea-4cb5-b0ef-cf8a71a71d6a">
<img width="252" alt="Screenshot 2023-07-17 at 15 15 27"
src="https://github.com/elastic/kibana/assets/924948/98b8b025-32fd-465e-9a66-40f4f866eb6e">

Selection with icons preview

<img width="260" alt="Screenshot 2023-07-17 at 15 07 17"
src="https://github.com/elastic/kibana/assets/924948/08dbda17-0c12-4fa4-8c92-77bbe90d7e14">
<img width="268" alt="Screenshot 2023-07-17 at 15 07 35"
src="https://github.com/elastic/kibana/assets/924948/78987838-42d5-46bf-9e46-b12cc603fa4e">

Panel with color styling open

<img width="266" alt="Screenshot 2023-07-17 at 15 07 44"
src="https://github.com/elastic/kibana/assets/924948/f5866e29-cf22-4e62-a2ff-3ef901c0d564">

Custom drilldowns (note Google icon has been replaced with a magnifier
icon)

<img width="331" alt="Screenshot 2023-07-18 at 17 49 07"
src="https://github.com/elastic/kibana/assets/924948/42e307d1-69b6-4e79-9e19-64c5efb7ee46">
<img width="381" alt="Screenshot 2023-07-18 at 17 51 44"
src="https://github.com/elastic/kibana/assets/924948/bc70c506-4390-45c1-aff5-8e22a68d7130">
<img width="271" alt="Screenshot 2023-07-17 at 15 08 31"
src="https://github.com/elastic/kibana/assets/924948/59fea7e4-a775-4006-805d-0610d7861890">
<img width="269" alt="Screenshot 2023-07-17 at 15 08 38"
src="https://github.com/elastic/kibana/assets/924948/f6c247a0-921d-4d9c-881a-796e02488df5">

Link selection

<img width="295" alt="Screenshot 2023-07-17 at 15 09 06"
src="https://github.com/elastic/kibana/assets/924948/d6a73013-130e-45a8-bdfc-48ac20e66a85">



### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: Michael Marcialis <[email protected]>
ThomThomson pushed a commit to ThomThomson/kibana that referenced this issue Aug 1, 2023
@dej611 @MichaelMarcialis
[Graph] Replace Fontawesome with EUI + Maki icons (elastic#162048)
e676ff0 
## Summary

Fixes elastic#160232

This PR removes completely FontAwesome from the Graph plugin and replace
its usage with mostly EUI + few Maki icons.
As for the Google icon, @MichaelMarcialis do you think we should just
have a custom SVG icon within the Graph app?

Here's a list of the replaced icons, but if I forgot anything let me
know:

* [x] Created generic `IconRenderer` component to abstract away the
package type from the rendering
  * [x] Add logic for color switch based on background color
* Replace icons in graph visualization
  * [x] Replace with EUI icons
  * [x] Replace with Maki icons
  * [x] Add `prevName` to recover old saved graph SO
  * [x] Fix selection preview icon
* For the `at` and `key` icons it needs to wait for a new EUI release
with elastic/eui#6934
* Replace drill down icons 
  * [x] Replace with EUI icons
  * [x] Replace with Maki icons
  * [x] Find a substitute for Google icon
  * [x] Add `prevName` to recover old saved graph SO
* App toolbars
  * [x] Replace app toolbar icons with EUI icons
    * [x] Changed blocked list icon from `ban` to `filterIgnore`
  * [x] Replace styling icon + color swatches
    * The EUI `dot` icon was too small, so switches to rect icons 
  * [x] Replace merge icons on link selection
  * [x] Replace group/ungroup icons with `fold/unfold`
  * [x] Custom drilldowns
* [x] Removed `LegacyIcon`
  * Replaced usage in various places

New icons within field configuration + graph visualization

<img width="1061" alt="Screenshot 2023-07-17 at 11 00 35"
src="https://github.com/elastic/kibana/assets/924948/59f981e7-64b7-4ce5-b3ae-2582d46fc373">

<img width="302" alt="Screenshot 2023-07-17 at 15 13 04"
src="https://github.com/elastic/kibana/assets/924948/fb8d0e63-e982-406f-bd8d-036d71d37442">

New toolbar with blocked icon changed

<img width="202" alt="Screenshot 2023-07-17 at 15 13 40"
src="https://github.com/elastic/kibana/assets/924948/241206c4-7d3b-4296-bd6b-c2df3f3eabe5">

<img width="220" alt="Screenshot 2023-07-17 at 15 13 35"
src="https://github.com/elastic/kibana/assets/924948/5a648932-2f79-4c0e-a8d0-3ab165f68036">

<img width="272" alt="Screenshot 2023-07-17 at 12 41 12"
src="https://github.com/elastic/kibana/assets/924948/e3778d20-3000-496e-881b-61e5f086ae52">

New group/ungroup icons

<img width="168" alt="Screenshot 2023-07-17 at 12 41 25"
src="https://github.com/elastic/kibana/assets/924948/ffc963e6-4fea-4cb5-b0ef-cf8a71a71d6a">
<img width="252" alt="Screenshot 2023-07-17 at 15 15 27"
src="https://github.com/elastic/kibana/assets/924948/98b8b025-32fd-465e-9a66-40f4f866eb6e">

Selection with icons preview

<img width="260" alt="Screenshot 2023-07-17 at 15 07 17"
src="https://github.com/elastic/kibana/assets/924948/08dbda17-0c12-4fa4-8c92-77bbe90d7e14">
<img width="268" alt="Screenshot 2023-07-17 at 15 07 35"
src="https://github.com/elastic/kibana/assets/924948/78987838-42d5-46bf-9e46-b12cc603fa4e">

Panel with color styling open

<img width="266" alt="Screenshot 2023-07-17 at 15 07 44"
src="https://github.com/elastic/kibana/assets/924948/f5866e29-cf22-4e62-a2ff-3ef901c0d564">

Custom drilldowns (note Google icon has been replaced with a magnifier
icon)

<img width="331" alt="Screenshot 2023-07-18 at 17 49 07"
src="https://github.com/elastic/kibana/assets/924948/42e307d1-69b6-4e79-9e19-64c5efb7ee46">
<img width="381" alt="Screenshot 2023-07-18 at 17 51 44"
src="https://github.com/elastic/kibana/assets/924948/bc70c506-4390-45c1-aff5-8e22a68d7130">
<img width="271" alt="Screenshot 2023-07-17 at 15 08 31"
src="https://github.com/elastic/kibana/assets/924948/59fea7e4-a775-4006-805d-0610d7861890">
<img width="269" alt="Screenshot 2023-07-17 at 15 08 38"
src="https://github.com/elastic/kibana/assets/924948/f6c247a0-921d-4d9c-881a-796e02488df5">

Link selection

<img width="295" alt="Screenshot 2023-07-17 at 15 09 06"
src="https://github.com/elastic/kibana/assets/924948/d6a73013-130e-45a8-bdfc-48ac20e66a85">



### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: Michael Marcialis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dej611 dej611

Labels
Feature:Graph Graph application feature impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Team:Visualizations Visualization editors, elastic-charts and infrastructure technical debt Improvement of the software architecture and operational architecture
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Graph] Replace Fontawesome with EUI + Maki icons dej611/kibana
3 participants
@dej611 @elasticmachine @stratoula