From c036fd284d869a3bef80d6cd40046b42099ead8e Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Wed, 17 Apr 2024 09:43:27 -0300 Subject: [PATCH 1/6] update README --- packages/mui-icons-material/README.md | 36 +++++++++++---------------- 1 file changed, 15 insertions(+), 21 deletions(-) diff --git a/packages/mui-icons-material/README.md b/packages/mui-icons-material/README.md index cf7d2d539d0db7..78e7703a11aaa4 100644 --- a/packages/mui-icons-material/README.md +++ b/packages/mui-icons-material/README.md @@ -1,44 +1,38 @@ # @mui/icons-material -This package provides the Google [Material Icons](https://fonts.google.com/icons?icon.set=Material+Icons) converted to [`SvgIcon`](https://mui.com/material-ui/api/svg-icon/) components. +This package contains Google's [Material Icons](https://fonts.google.com/icons?icon.set=Material+Icons) converted to the Material UI [`SvgIcon`](https://mui.com/material-ui/icons/#svgicon) component. + +> **Note:** Google has introduced a new set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for the former. ## Installation -Install the package in your project directory with: +The icons package depends on Material UI, so ensure you install both to use it. +Use the following command to install it: ```bash -npm install @mui/icons-material@next +npm install @mui/icons-material@next @mui/material@next @emotion/styled @emotion/react ``` -These components use the Material UI's [SvgIcon](https://next.mui.com/material-ui/api/svg-icon) component to render the SVG path for each icon. - -If you are not already using Material UI in your project, you can add it with: - - - -```bash -npm install @mui/material@next -``` - ## Documentation -- [The SvgIcon documentation](https://mui.com/material-ui/icons/#svgicon) -- [The Material Design icons search](https://mui.com/material-ui/material-icons/) +- Learn more about Material UI's [`SvgIcon` component](https://mui.com/material-ui/icons/#svgicon). +- Quickly search through the available icons on the [Material Icons page](https://mui.com/material-ui/material-icons/). ## Contributing -This icon set is meant to be in sync with Google's Material Icons. -Therefore, we don't accept fixes, additions, or any other contributions that would make this package diverge from the source. +The icons package is updated via a script that reads through the Material Icons set and extracts the SVG elements from there, as opposed to adding each icon individually. That said, we don't accept new icons that diverge from this source. -To synchronize with Material Icons, do the following: +To update the `@mui/icons-material` package with the Material Icons set, run the following commands: -1. Inside this workspace run `pnpm src:download` -2. Inside this workspace run `pnpm src:icons` -3. Inside the root run `pnpm docs:mdicons:synonyms` +1. In the "mui-icons-material" directory, run `pnpm src:download` +2. In the "mui-icons-material" directory, run `pnpm src:icons` +3. In the root of the Material UI repo, run `pnpm docs:mdicons:synonyms` 4. If the number of icons changes significantly, edit the icons/icons.md and material-icons/material-icons.md under docs/data/material/components and update the numbers. + +We roughly run them quarterly to make sure the package is up-to-date with the source. From 66f445e85742fb2a94dfbcd9cfd025166746b57d Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Wed, 17 Apr 2024 09:43:34 -0300 Subject: [PATCH 2/6] add note to the docs page as well --- .../data/material/components/material-icons/material-icons.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/data/material/components/material-icons/material-icons.md b/docs/data/material/components/material-icons/material-icons.md index ae09f5b703ff71..287a182d067cea 100644 --- a/docs/data/material/components/material-icons/material-icons.md +++ b/docs/data/material/components/material-icons/material-icons.md @@ -42,6 +42,10 @@ pnpm add @mui/icons-material@next @mui/material@next @emotion/styled @emotion/re See the [Installation](/material-ui/getting-started/installation/) page for additional docs about how to make sure everything is set up correctly. +:::info +Google has introduced a new set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for the former +::: +
## Search Material Icons From e9b9e8013338592dc43577c42d5368abb9466da8 Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Wed, 17 Apr 2024 09:56:13 -0300 Subject: [PATCH 3/6] quick iteration --- docs/data/material/components/material-icons/material-icons.md | 2 +- packages/mui-icons-material/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/data/material/components/material-icons/material-icons.md b/docs/data/material/components/material-icons/material-icons.md index 287a182d067cea..ff17f6484a454f 100644 --- a/docs/data/material/components/material-icons/material-icons.md +++ b/docs/data/material/components/material-icons/material-icons.md @@ -43,7 +43,7 @@ pnpm add @mui/icons-material@next @mui/material@next @emotion/styled @emotion/re See the [Installation](/material-ui/getting-started/installation/) page for additional docs about how to make sure everything is set up correctly. :::info -Google has introduced a new set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for the former +Google has introduced a new set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for supporting the former. :::
diff --git a/packages/mui-icons-material/README.md b/packages/mui-icons-material/README.md index 78e7703a11aaa4..b05c54be2632bb 100644 --- a/packages/mui-icons-material/README.md +++ b/packages/mui-icons-material/README.md @@ -2,7 +2,7 @@ This package contains Google's [Material Icons](https://fonts.google.com/icons?icon.set=Material+Icons) converted to the Material UI [`SvgIcon`](https://mui.com/material-ui/icons/#svgicon) component. -> **Note:** Google has introduced a new set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for the former. +> **Note:** Google has introduced a new set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for supporting the former. ## Installation From ec523ccf1423aaf5c4cee87b541e68bd94d16310 Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Wed, 17 Apr 2024 10:05:59 -0300 Subject: [PATCH 4/6] change wording --- docs/data/material/components/material-icons/material-icons.md | 2 +- packages/mui-icons-material/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/data/material/components/material-icons/material-icons.md b/docs/data/material/components/material-icons/material-icons.md index ff17f6484a454f..1f21437d354bd9 100644 --- a/docs/data/material/components/material-icons/material-icons.md +++ b/docs/data/material/components/material-icons/material-icons.md @@ -43,7 +43,7 @@ pnpm add @mui/icons-material@next @mui/material@next @emotion/styled @emotion/re See the [Installation](/material-ui/getting-started/installation/) page for additional docs about how to make sure everything is set up correctly. :::info -Google has introduced a new set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for supporting the former. +Google has introduced an alternative set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for supporting the former. :::
diff --git a/packages/mui-icons-material/README.md b/packages/mui-icons-material/README.md index b05c54be2632bb..8196b539fb64b2 100644 --- a/packages/mui-icons-material/README.md +++ b/packages/mui-icons-material/README.md @@ -2,7 +2,7 @@ This package contains Google's [Material Icons](https://fonts.google.com/icons?icon.set=Material+Icons) converted to the Material UI [`SvgIcon`](https://mui.com/material-ui/icons/#svgicon) component. -> **Note:** Google has introduced a new set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for supporting the former. +> **Note:** Google has introduced an alternative set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for supporting the former. ## Installation From 30f9afe69a9017ae2825954a54abf40553e710c5 Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Wed, 17 Apr 2024 15:47:04 -0300 Subject: [PATCH 5/6] wording change --- packages/mui-icons-material/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mui-icons-material/README.md b/packages/mui-icons-material/README.md index 8196b539fb64b2..4e0e97cb9462bc 100644 --- a/packages/mui-icons-material/README.md +++ b/packages/mui-icons-material/README.md @@ -35,4 +35,4 @@ To update the `@mui/icons-material` package with the Material Icons set, run the 3. In the root of the Material UI repo, run `pnpm docs:mdicons:synonyms` 4. If the number of icons changes significantly, edit the icons/icons.md and material-icons/material-icons.md under docs/data/material/components and update the numbers. -We roughly run them quarterly to make sure the package is up-to-date with the source. +We run them roughly quarterly to make sure the package is up-to-date with the source. From 9fb78442b168cd200b3655498306223757a1498f Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Wed, 29 May 2024 15:58:05 -0300 Subject: [PATCH 6/6] Sam's review --- .../components/material-icons/material-icons.md | 2 +- packages/mui-icons-material/README.md | 17 ++++++++--------- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/data/material/components/material-icons/material-icons.md b/docs/data/material/components/material-icons/material-icons.md index 1f21437d354bd9..5d73ad7804c819 100644 --- a/docs/data/material/components/material-icons/material-icons.md +++ b/docs/data/material/components/material-icons/material-icons.md @@ -43,7 +43,7 @@ pnpm add @mui/icons-material@next @mui/material@next @emotion/styled @emotion/re See the [Installation](/material-ui/getting-started/installation/) page for additional docs about how to make sure everything is set up correctly. :::info -Google has introduced an alternative set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for supporting the former. +Google also offers [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols) as an alternative to Material Icons. `@mui/icons-material` only covers Icons, and there are no plans to support Symbols at this time. :::
diff --git a/packages/mui-icons-material/README.md b/packages/mui-icons-material/README.md index 4e0e97cb9462bc..88979a9e52b10a 100644 --- a/packages/mui-icons-material/README.md +++ b/packages/mui-icons-material/README.md @@ -1,13 +1,12 @@ # @mui/icons-material -This package contains Google's [Material Icons](https://fonts.google.com/icons?icon.set=Material+Icons) converted to the Material UI [`SvgIcon`](https://mui.com/material-ui/icons/#svgicon) component. +This package contains Google's [Material Icons](https://fonts.google.com/icons?icon.set=Material+Icons) converted to Material UI [SVG Icon](https://mui.com/material-ui/icons/#svgicon) components. -> **Note:** Google has introduced an alternative set of icons called [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols), which differs from Material Icons. `@mui/icons-material` only covers the latter, with no plans yet for supporting the former. +> Google also offers [Material Symbols](https://fonts.google.com/icons?icon.set=Material+Symbols) as an alternative to Material Icons. `@mui/icons-material` only covers Icons, and there are no plans to support Symbols at this time. ## Installation -The icons package depends on Material UI, so ensure you install both to use it. -Use the following command to install it: +The Material Icons package depends on Material UI—install both with the following command: @@ -21,18 +20,18 @@ npm install @mui/icons-material@next @mui/material@next @emotion/styled @emotion -- Learn more about Material UI's [`SvgIcon` component](https://mui.com/material-ui/icons/#svgicon). -- Quickly search through the available icons on the [Material Icons page](https://mui.com/material-ui/material-icons/). +- Learn more about Material UI's [SVG Icon component](https://mui.com/material-ui/icons/#svgicon). +- Browse the available icons on the [Material Icons page](https://mui.com/material-ui/material-icons/). ## Contributing -The icons package is updated via a script that reads through the Material Icons set and extracts the SVG elements from there, as opposed to adding each icon individually. That said, we don't accept new icons that diverge from this source. +The Icons package is updated via a script that reads through Google's Material Icons set and extracts the SVG elements from there. Because of this, we don't accept new icons that diverge from the source. -To update the `@mui/icons-material` package with the Material Icons set, run the following commands: +To update the `@mui/icons-material` package with the latest Material Icons set, run the following commands: 1. In the "mui-icons-material" directory, run `pnpm src:download` 2. In the "mui-icons-material" directory, run `pnpm src:icons` 3. In the root of the Material UI repo, run `pnpm docs:mdicons:synonyms` 4. If the number of icons changes significantly, edit the icons/icons.md and material-icons/material-icons.md under docs/data/material/components and update the numbers. -We run them roughly quarterly to make sure the package is up-to-date with the source. +This process is performed by the maintainers on a quarterly basis.