Skip to content
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

Jump to bottom

Block Editor: JSDoc warnings fix #22976

Merged
merged 4 commits into from
Jun 6, 2020
Merged

Block Editor: JSDoc warnings fix #22976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
efbf89f
Fix for JSDoc warnings
mkaz Jun 6, 2020
9f1b4f2
Fix for JSDoc warnings
mkaz Jun 6, 2020
619a069
Apply suggestions from code review
mkaz Jun 6, 2020
8e761d3
Update packages/block-editor/src/components/block-toolbar/utils.js
mkaz Jun 6, 2020
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
3 changes: 2 additions & 1 deletion packages/block-editor/src/components/block-navigation/tree.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ import { BlockNavigationContext } from './context';
* recursive component (it renders itself), so this ensures TreeGrid is only
* present at the very top of the navigation grid.
*
* @param {Object} props
* @param {Object} props Components props.
* @param {Object} props.__experimentalFeatures Object used in context provider.
*/
export default function BlockNavigationTree( {
__experimentalFeatures,
Expand Down
13 changes: 12 additions & 1 deletion packages/block-editor/src/components/block-toolbar/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,13 @@ const {
const DEBOUNCE_TIMEOUT = 250;

/**
* Hook that creates a showMover state, as well as debounced show/hide callbacks
* Hook that creates a showMover state, as well as debounced show/hide callbacks.
*
* @param {Object} props Component props.
* @param {Object} props.ref Element reference.
* @param {boolean} props.isFocused Whether the component has current focus.
* @param {number} [props.debounceTimeout=250] Debounce timeout in milliseconds.
* @param {Function} [props.onChange=noop] Callback function.
*/
export function useDebouncedShowMovers( {
ref,
Expand Down Expand Up @@ -89,6 +95,11 @@ export function useDebouncedShowMovers( {
/**
* Hook that provides a showMovers state and gesture events for DOM elements
* that interact with the showMovers state.
*
* @param {Object} props Component props.
* @param {Object} props.ref Element reference.
* @param {number} [props.debounceTimeout=250] Debounce timeout in milliseconds.
* @param {Function} [props.onChange=noop] Callback function.
*/
export function useShowMoversGestures( {
ref,
Expand Down