Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs
update CodeVisibilityProvider to properly inherit from parent …
…context (Shopify#10467) <!-- ☝️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 - Prefix it with [WIP] while it’s a work in progress --> ### WHY are these changes introduced? Fixes Shopify#10400 <!-- link to issue if one exists --> ### WHAT is this pull request doing? Change the type signature of CodeVisibilityContext values ```diff - [bool, (arg: bool) => void] + { showCode?: bool, setShowCode?: (arg: bool) => void } ``` This is to ensure that we don't end up always inheriting the default values set by our createContext invocation for `CodeVisibilityContext` Changed the value instantiation for the CodeVisiblityProvider in Markdown.tsx ```diff -[ - codeVisibleFromContext ?? showCode, - setShowCodeFromContext ?? setShowCode -] +{ + showCode: typeof codeVisibleFromContext !== undefined ?? showCode, + setShowCode: setShowCodeFromContext ?? setShowCode, +} ``` To ensure that we also respect and inherit explicit `false` values when set in the parent context. ### 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
- Loading branch information