You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a package of animated icons which mirrors the icons in [Carbon Design System](https://carbondesignsystem.com/guidelines/icons/library/) icons.
4
-
It enables developers to import an animated icon directly from this library, in place of importing the existing static icon from the Carbon Design System library. The animated icons are implemented as React components. Since they do not make use of Carbon's icon components directly, they are not tied to a specific version of Carbon, and can be used in any React project.
4
+
It enables developers to import an animated icon directly from this library, in place of importing the existing static icon from the Carbon Design System library. The animated icons are implemented as React components. Since they do not make use of Carbon's icon components directly, they are not tied to a specific version of Carbon, and can be used in any React project.
5
5
6
6
Check out what the animations look like in this [example app](https://carbon-design-system.github.io/icons-motion/).
7
7
8
8
We will be adding onto this library one category at a time - the current release includes the **Navigation** icons and **Operations** icons. The **Formatting** icons are currently in progress, and toggle icons are being worked on as well.
9
-
If you want to request an icon/category to be animated, please open an issue using the **New icon animation** template. Working together with the Carbon team, we will prioritize the categories that will be most frequently used.
9
+
If you want to request an icon/category to be animated, please open an issue using the **New icon animation** template. Working together with the Carbon team, we will prioritize the categories that will be most frequently used.
10
10
11
11
We will do our very best to keep these icons in sync with the Carbon icons but if there is a change to the Carbon icon, it may not yet be reflected in our library- if you encounter this, please open a **Update icon animation** issue to alert us.
12
12
<br />
13
13
14
14
## Using the icons
15
15
16
16
### Installation
17
-
To use the icons in your project, first install the package:
17
+
18
+
To use the icons in your project, first install the package:
-`isAnimating` is a boolean; to trigger the animation, change this prop to `true`
46
-
-`size` is an integer which will set the width and height of the icon in px
43
+
-`size` is an integer which will set the width and height of the icon in px
47
44
48
-
**Important** Your app will need to update the `isAnimating` prop to `true` in order to make the icon animate. You can decide when/how this prop change should be triggered, depending on your specific use case.
45
+
**Important** Your app will need to update the `isAnimating` prop to `true` in order to make the icon animate. You can decide when/how this prop change should be triggered, depending on your specific use case.
49
46
50
47
Example:
51
48
Here's how to make an icon animate on mouseEnter of the `div` with the className of `icon-tile`, similar to the examples shown in the demo app at `./example/src/components/NavigationSection folder`.
52
49
53
50
Note in this example, all icons are imported as `*` so to use the specific icon, use `<icons.IconName>`
We welcome everyone who would like to contribute! Check out our [Contribution guidelines](https://github.com/carbon-design-system/icons-motion/blob/main/.github/CONTRIBUTING.md) to get started, and don't hesitate to reach out if you have any questions!
84
+
85
+
We welcome everyone who would like to contribute! Check out our [Contribution guidelines](https://github.com/carbon-design-system/icons-motion/blob/main/.github/CONTRIBUTING.md) to get started, and don't hesitate to reach out if you have any questions!
This library is in constant evolution, and we welcome any feedback to help it improve!
90
+
91
+
This library is in constant evolution, and we welcome any feedback to help it improve!
93
92
94
93
We'd especially love feedback in the following areas:
94
+
95
95
- New icons needed - propose additional icons you would like to see animated
96
96
- Animation feedback - too fast/slow/bouncy/whatever; conformance to existing animation guidelines
97
97
- Package feedback - improvements to code quality, efficiency, dependencies etc related to the actual package icon components
98
-
- Example app feedback - ideas on how to make the included demo app super engaging
98
+
- Example app feedback - ideas on how to make the included demo app super engaging
99
99
- Documentation feedback - Is the ReadMe clear? Did you have the information you needed to successfully edit/create icons, or use icons in your project?
100
-
- Implementation feedback - Did the icons work for your use case? Did you need different props?
100
+
- Implementation feedback - Did the icons work for your use case? Did you need different props?
101
101
102
102
<br />
103
103
104
104
## Contributors
105
+
105
106
This effort is lead by the Animated Icon Workgroup members: @kristastarr, @johnbister, @Motion-Mike, @silvio-hajdin
106
107
107
108
<br />
108
109
110
+
## <picture><sourceheight="20"width="20"media="(prefers-color-scheme: dark)"srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><sourceheight="20"width="20"media="(prefers-color-scheme: light)"srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><imgheight="20"width="20"alt="IBM Telemetry"src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry
111
+
112
+
This package uses IBM Telemetry to collect metrics data. By installing this package as a dependency
113
+
you are agreeing to telemetry collection. To opt out, see
114
+
[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
115
+
For more information on the data being collected, please see the
0 commit comments