Skip to content

Conversation

@krithikajanakiraman
Copy link
Contributor

@krithikajanakiraman krithikajanakiraman commented Jan 18, 2023

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.

Screenshot 2023-01-18 at 2 23 19 PM

How to 🎩

🖥 Local development instructions
🗒 General tophatting guidelines
📄 Changelog guidelines

Copy-paste this code in playground/Playground.tsx:
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>
  );
}

🎩 checklist

@github-actions github-actions bot added the cla-needed Added by a bot. Contributor needs to sign the CLA Agreement. label Jan 18, 2023
@krithikajanakiraman krithikajanakiraman requested a review from a team January 18, 2023 19:39
@krithikajanakiraman krithikajanakiraman marked this pull request as ready for review January 18, 2023 19:39
Copy link
Member

@chloerice chloerice left a 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 ResourceList component's documentation examples by adding a resource-list-with-header-content.tsx file to the polaris/polaris.shopify.com/pages/examples directory 😁

adding changeset

Update polaris-react/src/components/ResourceList/tests/ResourceList.test.tsx

Update polaris-react/src/components/ResourceList/ResourceList.tsx
@sam-b-rose sam-b-rose merged commit 18991da into Shopify:main Jan 25, 2023
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>
@gwyneplaine gwyneplaine mentioned this pull request Feb 14, 2023
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

Labels

cla-needed Added by a bot. Contributor needs to sign the CLA Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants