[v4][Page] Narrow width page #1606
Conversation
AndrewMusgrave
force-pushed
the
narrow-width-page
branch
from
2e7d6f3 to
2596cf9
Compare
AndrewMusgrave
force-pushed
the
narrow-width-page
branch
from
2596cf9 to
0e3f2e5
Compare
| } | ||
|
|
||
| export type ComposedProps = Props & WithAppProviderProps; | ||
| export interface DeprecatedProps { |
There was a problem hiding this comment.
If we wanted to, we could parse for this interface in the style guide (see bottom of the screenshot)
| export type ComposedProps = Props & WithAppProviderProps; | ||
| export interface DeprecatedProps { | ||
| /** Decreases the maximum layout width. Intended for single-column layouts | ||
| * @deprecated As of release 4.0, replaced by {@link https://polaris.shopify.com/components/structure/page#props-narrow-width} |
There was a problem hiding this comment.
We don't currently use these tags in the style guide, but ids should be added to the props none the less
There was a problem hiding this comment.
I prefer this as well—using the correct tags and following standards. That way it is there if we want to support it in the future and/or change to tool we used to parse this.
| } | ||
|
|
||
| export default withAppProvider<Props>()(Page); | ||
| export default withAppProvider<Props & DeprecatedProps>()(Page); |
There was a problem hiding this comment.
<Props & DeprecatedProps> is our public API
| it('warns the singleColumn prop has been renamed', () => { | ||
| const warningSpy = jest | ||
| .spyOn(console, 'warn') | ||
| .mockImplementation(() => {}); |
There was a problem hiding this comment.
Blocking the warning spam in our test output
AndrewMusgrave
force-pushed
the
narrow-width-page
branch
from
0e3f2e5 to
f39c5a4
Compare
AndrewMusgrave
added
the
🤖Skip Changelog
AndrewMusgrave
changed the title
I like it |
3 participants
WHY are these changes introduced?
Fixes #1572
@tmlayton For documentation, what do you think about sectioning out deprecated props rather than removing them? Where
Deprecated Propscould be ourDeprecatedPropsinterface?