Skip to content

[Layout Foundation][Box] Add support for passing in role attribute #7799

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.

Sign up for GitHub

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
merged 8 commits into from
Nov 25, 2022
Merged

[Layout Foundation][Box] Add support for passing in role attribute #7799

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
761f725
Add role attribute to `Box`
chazdean Nov 24, 2022
297a2e8
Refactor role
chazdean Nov 24, 2022
fa56bb9
Update props.json
chazdean Nov 24, 2022
0093388
Delete five-nails-travel.md
chazdean Nov 24, 2022
57e2010
Update polaris-react/src/components/Box/Box.tsx
chazdean Nov 25, 2022
2126f95
Update polaris-react/src/components/Box/Box.tsx
chazdean Nov 25, 2022
fa0713f
Update polaris-react/src/components/Box/Box.tsx
chazdean Nov 25, 2022
b9d607d
Update props.json
chazdean Nov 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/hip-grapes-build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@shopify/polaris': minor
'polaris.shopify.com': patch
---

Updated `Box` to accept role attribute
5 changes: 5 additions & 0 deletions polaris-react/src/components/Box/Box.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import styles from './Box.scss';
type Element = 'div' | 'span' | 'section';
type Overflow = 'hidden' | 'scroll';
type Position = 'relative' | 'absolute' | 'fixed' | 'sticky';
type Role = 'status';

export type ColorTokenScale =
| 'text'
Expand Down Expand Up @@ -150,6 +151,8 @@ export interface BoxProps extends React.AriaAttributes {
* paddingInlineEnd={{xs: '2', sm: '3', md: '4', lg: '5', xl: '6'}}
*/
paddingInlineEnd?: Spacing;
/** role of box */
role?: Role;
/** Shadow on box */
shadow?: DepthShadowAlias;
/** Width of container */
Expand Down Expand Up @@ -206,6 +209,7 @@ export const Box = forwardRef<HTMLElement, BoxProps>(
paddingBlockEnd,
paddingInlineStart,
paddingInlineEnd,
role,
shadow,
width,
visuallyHidden,
Expand Down Expand Up @@ -327,6 +331,7 @@ export const Box = forwardRef<HTMLElement, BoxProps>(
id,
ref,
style: sanitizeCustomProperties(style),
role,
...restProps,
},
children,
Expand Down
Loading