Update docs for ClipboardButton component #34711
Conversation
ryanwelcher
added
[Type] Developer Documentation
ryanwelcher
requested review from
ajitbohra and
chrisvanpatten
as code owners
There was a problem hiding this comment.
Thank you for continuing to work on adding missing docs to the components, @ryanwelcher !
Since the ClipboardButton component is deprecated, we should add a deprecation notice at the top of the README (similarly to how we flag experimental components)
<div class="callout callout-alert">
This component is deprecated. Please use the `useCopyToClipboard` hook from the `@wordpress/compose` package instead.
</div>
|
@ciampo @jorgefilipecosta thanks for the feedback! I've updated the PR, please have a look and let me know if there is anything further! |
| The text that will be copied to the clipboard. | ||
|
|
||
| - Type: `string` | ||
| - Required: no |
There was a problem hiding this comment.
From a quick look at the code, it seems like text would be required — WDYT?
There was a problem hiding this comment.
This totally makes sense to be marked as required. I checked this and it doesn't fire errors but I think the idea of it being required to use the component rather than required to not break it is a good distinction.
There was a problem hiding this comment.
Looking good! Feel free to merge after this comment is addressed
* trunk: (74 commits) Update docs for ClipboardButton component (#34711) Post Title Block: add typography formatting options (#31623) Bump plugin version to 11.5.0 Navigation Screen: Adjust header toolbar icon styles (#34833) Fix the parent menu item field in REST API responses (#34835) Rewrite FocusableIframe as hook API (#26753) Create Block: Remove wp-cli callout since not recommended and outdated (#34821) Global Styles: Fix dimensions panel default controls display (#34828) [RNMobile][Embed block] Enable embed preview for Instagram and Vimeo providers (#34563) Increase Link UI search results to 10 on Nav Editor screen (#34808) Prevent welcome guide overflow x scroll (#34713) Enable open on click for Page List inside Navigation. (#34675) [RNMobile] [Embed block] - Unavailable preview fallback bottom sheet title update (#34674) Add missing field _invalid in menu item REST API (#34670) Fix Dropdown/DropdownMenu toggle closing in all UAs (#31170) Navigation submenu block: replace global shortcut event handlers with local ones (#34812) Navigation Screen: Consolidate menu name and switcher (#34786) Remove parent and position validation from menu item REST API endpoint (#34672) Clean theme data when switching themes in the customizer (#34540) Components: add reset timeout to ColorPicker's copy functionality. (#34601) ...
Description
Update docs for ClipboardButton component to fix the usage example and add props entries. Part of the ongoing effort in #33263
Types of changes
Docs only
Checklist:
*.native.jsfiles for terms that need renaming or removal).