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.

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

[Docs] How to optimize icons contribution guidance #11634

Merged
merged 3 commits into from
Feb 29, 2024

Conversation

heyjoethomas
Copy link
Contributor

WHY are these changes introduced?

We need to make sure all icons that are contributed to Polaris are optimized to keep our bundle size small and lean.

WHAT is this pull request doing?

This PR adds content showing how to optimize new icons being added to Polaris.

Screenshot 2024-02-21 at 1 32 25 PM

How to 🎩

🖥 Local development instructions
🗒 General tophatting guidelines
📄 Changelog guidelines

🎩 checklist

Adds content about optimizing icons to contributing guide.
Reorder instructions
@heyjoethomas heyjoethomas added Documentation Icon Polaris iconography labels Feb 21, 2024
@heyjoethomas heyjoethomas self-assigned this Feb 21, 2024
@heyjoethomas heyjoethomas merged commit 27ca061 into main Feb 29, 2024
13 checks passed
@heyjoethomas heyjoethomas deleted the docs-optimize-icon-content branch February 29, 2024 20:30
mrcthms pushed a commit that referenced this pull request Mar 5, 2024
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @shopify/polaris-icons@8.7.0

### Minor Changes

- [#11682](#11682)
[`9eebf1a45`](9eebf1a)
Thanks [@heyjoethomas](https://github.com/heyjoethomas)! - Fixes
clipping on mobile


- [#11686](#11686)
[`9b1b74447`](9b1b744)
Thanks [@heyjoethomas](https://github.com/heyjoethomas)! - Update icons
for mobile clipping


- [#11687](#11687)
[`eeea3b96c`](eeea3b9)
Thanks [@heyjoethomas](https://github.com/heyjoethomas)! - Minus and
Plus icons to big and unbalanced

### Patch Changes

- [#11685](#11685)
[`ac563025e`](ac56302)
Thanks [@sam-b-rose](https://github.com/sam-b-rose)! - Removed REM units
from SkeletonIcon

## @shopify/polaris@12.20.0

### Minor Changes

- [#11663](#11663)
[`ab2877249`](ab28772)
Thanks [@mrcthms](https://github.com/mrcthms)! - Updated `BulkActions`
to support containing a flat array of actions into a single section
within the ActionList


- [#11674](#11674)
[`042b428be`](042b428)
Thanks [@mrcthms](https://github.com/mrcthms)! - Updated BulkActions to
show titles of sections if provided

### Patch Changes

- [#11670](#11670)
[`c2e443ec9`](c2e443e)
Thanks [@mrcthms](https://github.com/mrcthms)! - Updated IndexTable so
that no bulk actions are required to see the paginated select all text


- [#11684](#11684)
[`75dcb5443`](75dcb54)
Thanks [@mrcthms](https://github.com/mrcthms)! - Updated Actions to
safeguard against incorrect prop shapes being passed to it


- [#11648](#11648)
[`8c7302e11`](8c7302e)
Thanks [@trtri2](https://github.com/trtri2)! - Fixed hover styles to
multiple selection variant of `OptionList`


- [#11665](#11665)
[`4263d9ada`](4263d9a)
Thanks [@mrcthms](https://github.com/mrcthms)! - Fixed `IndexFilters`
responding to keyboard shortcuts when there is no search field or
filters

- Updated dependencies
\[[`ac563025e`](ac56302),
[`9eebf1a45`](9eebf1a),
[`9b1b74447`](9b1b744),
[`eeea3b96c`](eeea3b9)]:
    -   @shopify/polaris-icons@8.7.0

## polaris.shopify.com@0.64.0

### Minor Changes

- [#11674](#11674)
[`042b428be`](042b428)
Thanks [@mrcthms](https://github.com/mrcthms)! - Updated BulkActions to
show titles of sections if provided


- [#11683](#11683)
[`8a0e1b32f`](8a0e1b3)
Thanks [@heyjoethomas](https://github.com/heyjoethomas)! - Update design
guidance for icons


- [#11634](#11634)
[`27ca061a6`](27ca061)
Thanks [@heyjoethomas](https://github.com/heyjoethomas)! - Adds guidance
on optimzing icons to contribution page

### Patch Changes

- Updated dependencies
\[[`c2e443ec9`](c2e443e),
[`ab2877249`](ab28772),
[`ac563025e`](ac56302),
[`75dcb5443`](75dcb54),
[`042b428be`](042b428),
[`9eebf1a45`](9eebf1a),
[`8c7302e11`](8c7302e),
[`4263d9ada`](4263d9a),
[`9b1b74447`](9b1b744),
[`eeea3b96c`](eeea3b9)]:
    -   @shopify/polaris@12.20.0
    -   @shopify/polaris-icons@8.7.0

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
sam-b-rose added a commit that referenced this pull request Mar 8, 2024
* main:
  [Icons] Fixes clipping on mobile (#11682)
  [OptionList] Support hover styles for multiple selection variant  (#11648)
  [Docs] How to optimize icons contribution guidance (#11634)
  [BulkActions] Add titles to sections if provided (#11674)
  [IndexTable] Allow paginatedSelectAllAction to be visible without having to provide bulkActions prop (#11670)
AnnaCheba pushed a commit to AnnaCheba/polaris that referenced this pull request Apr 22, 2024
<!--
  ☝️How to write a good PR title:
- Prefix it with [ComponentName] (if applicable), for example: [Button]
  - Start with a verb, for example: Add, Delete, Improve, Fix…
  - Give as much context as necessary and as little as possible
  - Open it as a draft if it’s a work in progress
-->

### WHY are these changes introduced?

We need to make sure all icons that are contributed to Polaris are
optimized to keep our bundle size small and lean.

<!--
  Context about the problem that’s being addressed.
-->

### WHAT is this pull request doing?

This PR adds content showing how to optimize new icons being added to
Polaris.

<img width="890" alt="Screenshot 2024-02-21 at 1 32 25 PM"
src="https://github.com/Shopify/polaris/assets/5749440/214257b5-20a1-4115-9d30-b491422db646">


### How to 🎩

🖥 [Local development
instructions](https://github.com/Shopify/polaris/blob/main/README.md#install-dependencies-and-build-workspaces)
🗒 [General tophatting
guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md)
📄 [Changelog
guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)

### 🎩 checklist

- [ ] Tested a
[snapshot](https://github.com/Shopify/polaris/blob/main/documentation/Releasing.md#-snapshot-releases)
- [ ] Tested on
[mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing)
- [ ] Tested on [multiple
browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers)
- [ ] Tested for
[accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md)
- [ ] Updated the component's `README.md` with documentation changes
- [ ] [Tophatted
documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md)
changes in the style guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Icon Polaris iconography
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants