-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[ResourceList] Add headerContent prop for customizing header on ResourceList #8083
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
Merged
sam-b-rose
merged 1 commit into
Shopify:main
from
krithikajanakiraman:resource_list_header
Jan 25, 2023
Merged
[ResourceList] Add headerContent prop for customizing header on ResourceList #8083
sam-b-rose
merged 1 commit into
Shopify:main
from
krithikajanakiraman:resource_list_header
Jan 25, 2023
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chloerice
approved these changes
Jan 24, 2023
Member
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for contributing @krithikajanakiraman! Tophat and code look good to me 👍🏽
You just need to also:
- Sign the Shopify CLA (see the failing check's "Details" button)
- Add the "With header content" example to the
ResourceListcomponent's documentation examples by adding aresource-list-with-header-content.tsxfile to thepolaris/polaris.shopify.com/pages/examplesdirectory 😁
polaris-react/src/components/ResourceList/tests/ResourceList.test.tsx
Outdated
Show resolved
Hide resolved
adding changeset Update polaris-react/src/components/ResourceList/tests/ResourceList.test.tsx Update polaris-react/src/components/ResourceList/ResourceList.tsx
d73edb4 to
6230b75
Compare
Merged
yurm04
pushed a commit
that referenced
this pull request
Jan 26, 2023
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@6.10.0 ### Minor Changes - [#8150](#8150) [`a0c6e467b`](a0c6e46) Thanks [@leileu](https://github.com/leileu)! - Adding two metaobject icons: Metaobject and Metaobject Reference. ### Patch Changes - [#8148](#8148) [`0ca0b7899`](0ca0b78) Thanks [@zecarlostorre](https://github.com/zecarlostorre)! - Updated clipboard icon ## @shopify/polaris@10.24.0 ### Minor Changes - [#8083](#8083) [`18991daf1`](18991da) Thanks [@krithikajanakiraman](https://github.com/krithikajanakiraman)! - Adding an oprtional headerContent prop to ResourceList - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ActionList` to use layout primitives - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `SkeletonPage` to use primitive Layout components Removed `max-width` on children in `AlphaStack` Added `narrowWidth` and `fullWidth` examples to `AlphaStack` stories ### Patch Changes - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Updated `SkeletonPage` title and body layout - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `SkeletonPage` title layout - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Fixed `ResourceList` header alignment - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ResourceItem` with layout components - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Fixed IndexTable checkbox alignment - [#8099](#8099) [`a3605c855`](a3605c8) Thanks [@AndrewMusgrave](https://github.com/AndrewMusgrave)! - Fixed `BulkActions` causing `IndexTable` & `ResourceList` to ignore pointer events - Updated dependencies \[[`a0c6e467b`](a0c6e46), [`0ca0b7899`](0ca0b78)]: - @shopify/polaris-icons@6.10.0 ## @shopify/plugin-polaris@0.0.31 ### Patch Changes - Updated dependencies \[]: - @shopify/polaris-migrator@0.11.2 ## @shopify/polaris-migrator@0.11.2 ### Patch Changes - Updated dependencies \[[`07669075a`](0766907), [`74a75a473`](74a75a4), [`f8f9eecd5`](f8f9eec)]: - @shopify/stylelint-polaris@5.1.2 ## @shopify/stylelint-polaris@5.1.2 ### Patch Changes - [#8167](#8167) [`07669075a`](0766907) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Temporarily disable layout category - [#8162](#8162) [`74a75a473`](74a75a4) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Allow SCSS namespaces with Polaris breakpoints - [#8168](#8168) [`f8f9eecd5`](f8f9eec) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Ignored needless disables for layout category and added meta URL to error message ## polaris.shopify.com@0.30.1 ### Patch Changes - [#8123](#8123) [`3bb6c03d3`](3bb6c03) Thanks [@marlowpayne](https://github.com/marlowpayne)! - Improve readability of markdown tables by wrapping on words - [#8045](#8045) [`b3ee45c47`](b3ee45c) Thanks [@sarahill](https://github.com/sarahill)! - Added component lifecycle page to polaris.shopify.com - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ActionList` to use layout primitives - Updated dependencies \[[`a0941743a`](a094174), [`18991daf1`](18991da), [`a0941743a`](a094174), [`a0941743a`](a094174), [`a0941743a`](a094174), [`a0941743a`](a094174), [`a0941743a`](a094174), [`a0941743a`](a094174), [`a0c6e467b`](a0c6e46), [`a3605c855`](a3605c8), [`0ca0b7899`](0ca0b78)]: - @shopify/polaris@10.24.0 - @shopify/polaris-icons@6.10.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Merged
juzser
pushed a commit
to juzser/polaris
that referenced
this pull request
Jul 27, 2023
…rceList (Shopify#8083) ### WHY are these changes introduced? Related issue https://github.com/Shopify/ecosystem-merchant-engagement/issues/1106 Currently there is no way to show a customized header on the resource list and the only options available are 'Showing x items' or 'Showing x of y items'. As part of the updated app settings project on admin, we wanted to show some other content and got in touch with the polaris team and learnt we could contribute since this doesn't exist at the moment. ### WHAT is this pull request doing? This PR adds an optional headerContent prop of type string which lets the user pass in any heading they want to display on the resource list header. <img width="750" alt="Screenshot 2023-01-18 at 2 23 19 PM" src="https://user-images.githubusercontent.com/59700774/213275258-eb1d8fac-742a-4835-9d45-6ff38701839c.png"> ### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [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) <!-- Give as much information as needed to experiment with the component in the playground. --> <details> <summary>Copy-paste this code in <code>playground/Playground.tsx</code>:</summary> ```jsx import React from 'react'; import {Page} from '../src'; export function Playground() { return ( <Page title="Playground"> {/* Add the code you want to test in here */} </Page> ); } ``` </details> ### 🎩 checklist - [ ] 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 Co-authored-by: Krithika Janakiraman <krithikajanakiraman@Krithikas-MacBook-Pro-2.local>
juzser
pushed a commit
to juzser/polaris
that referenced
this pull request
Jul 27, 2023
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@6.10.0 ### Minor Changes - [Shopify#8150](Shopify#8150) [`a0c6e467b`](Shopify@a0c6e46) Thanks [@leileu](https://github.com/leileu)! - Adding two metaobject icons: Metaobject and Metaobject Reference. ### Patch Changes - [Shopify#8148](Shopify#8148) [`0ca0b7899`](Shopify@0ca0b78) Thanks [@zecarlostorre](https://github.com/zecarlostorre)! - Updated clipboard icon ## @shopify/polaris@10.24.0 ### Minor Changes - [Shopify#8083](Shopify#8083) [`18991daf1`](Shopify@18991da) Thanks [@krithikajanakiraman](https://github.com/krithikajanakiraman)! - Adding an oprtional headerContent prop to ResourceList - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ActionList` to use layout primitives - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `SkeletonPage` to use primitive Layout components Removed `max-width` on children in `AlphaStack` Added `narrowWidth` and `fullWidth` examples to `AlphaStack` stories ### Patch Changes - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Updated `SkeletonPage` title and body layout - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `SkeletonPage` title layout - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Fixed `ResourceList` header alignment - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ResourceItem` with layout components - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Fixed IndexTable checkbox alignment - [Shopify#8099](Shopify#8099) [`a3605c855`](Shopify@a3605c8) Thanks [@AndrewMusgrave](https://github.com/AndrewMusgrave)! - Fixed `BulkActions` causing `IndexTable` & `ResourceList` to ignore pointer events - Updated dependencies \[[`a0c6e467b`](Shopify@a0c6e46), [`0ca0b7899`](Shopify@0ca0b78)]: - @shopify/polaris-icons@6.10.0 ## @shopify/plugin-polaris@0.0.31 ### Patch Changes - Updated dependencies \[]: - @shopify/polaris-migrator@0.11.2 ## @shopify/polaris-migrator@0.11.2 ### Patch Changes - Updated dependencies \[[`07669075a`](Shopify@0766907), [`74a75a473`](Shopify@74a75a4), [`f8f9eecd5`](Shopify@f8f9eec)]: - @shopify/stylelint-polaris@5.1.2 ## @shopify/stylelint-polaris@5.1.2 ### Patch Changes - [Shopify#8167](Shopify#8167) [`07669075a`](Shopify@0766907) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Temporarily disable layout category - [Shopify#8162](Shopify#8162) [`74a75a473`](Shopify@74a75a4) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Allow SCSS namespaces with Polaris breakpoints - [Shopify#8168](Shopify#8168) [`f8f9eecd5`](Shopify@f8f9eec) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Ignored needless disables for layout category and added meta URL to error message ## polaris.shopify.com@0.30.1 ### Patch Changes - [Shopify#8123](Shopify#8123) [`3bb6c03d3`](Shopify@3bb6c03) Thanks [@marlowpayne](https://github.com/marlowpayne)! - Improve readability of markdown tables by wrapping on words - [Shopify#8045](Shopify#8045) [`b3ee45c47`](Shopify@b3ee45c) Thanks [@sarahill](https://github.com/sarahill)! - Added component lifecycle page to polaris.shopify.com - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ActionList` to use layout primitives - Updated dependencies \[[`a0941743a`](Shopify@a094174), [`18991daf1`](Shopify@18991da), [`a0941743a`](Shopify@a094174), [`a0941743a`](Shopify@a094174), [`a0941743a`](Shopify@a094174), [`a0941743a`](Shopify@a094174), [`a0941743a`](Shopify@a094174), [`a0941743a`](Shopify@a094174), [`a0c6e467b`](Shopify@a0c6e46), [`a3605c855`](Shopify@a3605c8), [`0ca0b7899`](Shopify@0ca0b78)]: - @shopify/polaris@10.24.0 - @shopify/polaris-icons@6.10.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Related issue https://github.com/Shopify/ecosystem-merchant-engagement/issues/1106
Currently there is no way to show a customized header on the resource list and the only options available are 'Showing x items' or 'Showing x of y items'.
As part of the updated app settings project on admin, we wanted to show some other content and got in touch with the polaris team and learnt we could contribute since this doesn't exist at the moment.
WHAT is this pull request doing?
This PR adds an optional headerContent prop of type string which lets the user pass in any heading they want to display on the resource list header.
How to 🎩
🖥 Local development instructions
🗒 General tophatting guidelines
📄 Changelog guidelines
Copy-paste this code in
playground/Playground.tsx:🎩 checklist
README.mdwith documentation changes