Skip to content

Add README for useMovingAnimation hook with usage and performance gui… - #69463

Closed
vk17-starlord wants to merge 1 commit into
WordPress:trunkfrom
vk17-starlord:use-moving-animation-readme
Closed

vk17-starlord wants to merge 1 commit into
WordPress:trunkfrom
vk17-starlord:use-moving-animation-readme

Conversation

@vk17-starlord

Copy link
Copy Markdown
Contributor

PR Description

What?
Closes Issue #52077

This PR adds a README.md file for the use-moving-animation component in the Gutenberg project.

Why?
The use-moving-animation component was missing a README.md file, which is important for providing documentation and clarity on the component's purpose and usage.

How?

  • Created a new README.md file for the use-moving-animation component.
  • Detailed the useMovingAnimation hook, including its usage, parameters, return values, and animation behavior.
  • Provided development guidelines and important notes about the component.

Testing Instructions

  1. Navigate to the use-moving-animation component directory.
  2. Ensure the new README.md file is present and contains relevant information about the component.
  3. Review the content to verify it aligns with Gutenberg documentation standards.

Testing Instructions for Keyboard

  • Navigate through the documentation using keyboard shortcuts to ensure accessibility.

@vk17-starlord
vk17-starlord requested a review from ellatrix as a code owner March 6, 2025 09:05
@github-actions

github-actions Bot commented Mar 6, 2025 •

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: vk17-starlord <vineet2003@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: mburridge <mburridge@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@Mamaduka

Mamaduka commented Mar 6, 2025

Copy link
Copy Markdown
Member

Thanks for contributing, @vk17-starlord!

Before you continue working on documentation PRs, please see #22891 (comment).

@Mamaduka Mamaduka added the [Type] Developer Documentation Documentation for developers label Mar 6, 2025
@youknowriad

Copy link
Copy Markdown
Contributor

This is an internal component. I don't think it needs a README, some more JSDocs could be helpful though.

@youknowriad youknowriad closed this Dec 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add README.md file for use-moving-animation component

3 participants