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.

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

Animate: type getAnimateClassName #27123

Merged
merged 17 commits into from
Dec 1, 2020
Merged

Conversation

sirreal
Copy link
Member

@sirreal sirreal commented Nov 19, 2020

Description

  • Rename useAnimate to getAnimateClassName (publicly __unstableGetAnimateClassName) and treat it as a regular function. It's implementation is not like a hook and it doesn't need to be treated as one.
  • Type getAnimateClassName.

Closes #26965 (supersedes).

How has this been tested?

  • Storybook

Types of changes

  • Internal: Code quality. Type getAnimateClassName.
  • Internal: Change unstable function name.

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@github-actions
Copy link

github-actions bot commented Nov 19, 2020

Size Change: +8 B (0%)

Total Size: 1.19 MB

Filename Size Change
build/annotations/index.js 3.8 kB -1 B
build/block-directory/index.js 8.72 kB +1 B
build/block-editor/index.js 128 kB -52 B (0%)
build/block-library/index.js 148 kB +6 B (0%)
build/block-library/style.css 8.27 kB +1 B
build/blocks/index.js 48.1 kB +5 B (0%)
build/components/index.js 172 kB +67 B (0%)
build/compose/index.js 9.95 kB +1 B
build/dom/index.js 4.95 kB +1 B
build/edit-navigation/index.js 11.1 kB -3 B (0%)
build/edit-post/index.js 306 kB -21 B (0%)
build/edit-site/index.js 24.1 kB +3 B (0%)
build/edit-widgets/index.js 26.3 kB -8 B (0%)
build/editor/index.js 43.3 kB +14 B (0%)
build/element/index.js 4.63 kB -1 B
build/format-library/index.js 6.86 kB -3 B (0%)
build/keyboard-shortcuts/index.js 2.54 kB +1 B
build/keycodes/index.js 1.94 kB +1 B
build/list-reusable-blocks/index.js 3.1 kB -2 B (0%)
build/media-utils/index.js 5.32 kB +2 B (0%)
build/plugins/index.js 2.56 kB -2 B (0%)
build/rich-text/index.js 13.4 kB -2 B (0%)
build/server-side-render/index.js 2.77 kB -2 B (0%)
build/viewport/index.js 1.86 kB +2 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/api-fetch/index.js 3.42 kB 0 B
build/autop/index.js 2.84 kB 0 B
build/blob/index.js 665 B 0 B
build/block-directory/style-rtl.css 943 B 0 B
build/block-directory/style.css 942 B 0 B
build/block-editor/style-rtl.css 11.2 kB 0 B
build/block-editor/style.css 11.2 kB 0 B
build/block-library/editor-rtl.css 8.95 kB 0 B
build/block-library/editor.css 8.95 kB 0 B
build/block-library/style-rtl.css 8.27 kB 0 B
build/block-library/theme-rtl.css 789 B 0 B
build/block-library/theme.css 790 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.06 kB 0 B
build/components/style-rtl.css 15.3 kB 0 B
build/components/style.css 15.3 kB 0 B
build/core-data/index.js 14.8 kB 0 B
build/data-controls/index.js 827 B 0 B
build/data/index.js 8.98 kB 0 B
build/date/index.js 11.2 kB 0 B
build/deprecated/index.js 768 B 0 B
build/dom-ready/index.js 571 B 0 B
build/edit-navigation/style-rtl.css 881 B 0 B
build/edit-navigation/style.css 885 B 0 B
build/edit-post/style-rtl.css 6.42 kB 0 B
build/edit-post/style.css 6.4 kB 0 B
build/edit-site/style-rtl.css 3.91 kB 0 B
build/edit-site/style.css 3.91 kB 0 B
build/edit-widgets/style-rtl.css 3.13 kB 0 B
build/edit-widgets/style.css 3.13 kB 0 B
build/editor/editor-styles-rtl.css 476 B 0 B
build/editor/editor-styles.css 478 B 0 B
build/editor/style-rtl.css 3.85 kB 0 B
build/editor/style.css 3.85 kB 0 B
build/escape-html/index.js 735 B 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 2.27 kB 0 B
build/html-entities/index.js 623 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 698 B 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/notices/index.js 1.82 kB 0 B
build/nux/index.js 3.42 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/primitives/index.js 1.43 kB 0 B
build/priority-queue/index.js 791 B 0 B
build/redux-routine/index.js 2.84 kB 0 B
build/reusable-blocks/index.js 2.92 kB 0 B
build/shortcode/index.js 1.69 kB 0 B
build/token-list/index.js 1.27 kB 0 B
build/url/index.js 2.84 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.22 kB 0 B

compressed-size-action

Copy link
Member

@ellatrix ellatrix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

packages/components/src/animate/index.js Outdated Show resolved Hide resolved
packages/components/src/animate/index.js Outdated Show resolved Hide resolved
packages/components/src/animate/index.js Outdated Show resolved Hide resolved
@sirreal sirreal force-pushed the update/deprecate-type-animate branch from 39ebf5a to 8d7f5a2 Compare November 25, 2020 17:09
@sirreal sirreal marked this pull request as ready for review November 25, 2020 21:50
@sirreal sirreal added the [Package] Components /packages/components label Nov 25, 2020
@sirreal sirreal self-assigned this Nov 25, 2020
@sirreal sirreal requested a review from ellatrix November 25, 2020 21:51
@@ -14,7 +14,7 @@ export {
export { default as __experimentalAlignmentMatrixControl } from './alignment-matrix-control';
export {
default as Animate,
useAnimate as __unstableUseAnimate,
getAnimateClassName as __experimentalGetAnimateClassName,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just noticed this was __unstable - not intended for use outside of Gutenberg. Should it stay that way?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're confident in the API, we can stabilise it? The question is, do we intend to use this for future animations, or are there new methods there days? Cc @jasmussen.

Copy link
Contributor

@jasmussen jasmussen Nov 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sad to say I've not had enough of a chance to leverage this one quite yet, to make a call. However I recall @youknowriad being pretty excited about it?

or are there new methods there days?

I think there's a place for both, perhaps even with emphasis on the class.

Copy link
Member Author

@sirreal sirreal Nov 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I can land this PR with the rename and keep it marked unstable. A follow-up could mark it experimental or stabilize.

Restored unstable in d510658

@sirreal sirreal force-pushed the update/deprecate-type-animate branch from 0f71b55 to d510658 Compare November 26, 2020 10:08
@sirreal
Copy link
Member Author

sirreal commented Nov 27, 2020

@ellatrix I know you approved this, but it wasn't ready at the time so I'm disregarding. I can't actually dismiss the review for some reason 🤷‍♂️

I do think it's ready for review at this time 🙇‍♂️

packages/components/tsconfig.json Outdated Show resolved Hide resolved
packages/components/tsconfig.json Outdated Show resolved Hide resolved
packages/components/tsconfig.json Outdated Show resolved Hide resolved
packages/components/tsconfig.json Outdated Show resolved Hide resolved
@sirreal
Copy link
Member Author

sirreal commented Nov 27, 2020

Thanks for catching those mistakes, @saramarcondes. I've cleaned them up.

@ellatrix
Copy link
Member

Consider my approval given for any additional commits. Looks like there's still a few tests failures, but other than that it looks good!

@sirreal sirreal added [Type] Code Quality Issues or PRs that relate to code quality Needs Dev Note Requires a developer note for a major WordPress release cycle labels Nov 28, 2020
@sirreal sirreal force-pushed the update/deprecate-type-animate branch from c2d6dba to 44e5917 Compare November 30, 2020 09:16
@sirreal sirreal force-pushed the update/deprecate-type-animate branch from 53d9699 to b0cadc6 Compare November 30, 2020 12:19
@sirreal
Copy link
Member Author

sirreal commented Nov 30, 2020

I'll break this into 2 PRs - we shouldn't deprecate Animate without stabilizing its alternative and adding a dev note. I'll focus this PR on typing and renaming the class name helper.

@sirreal sirreal removed the Needs Dev Note Requires a developer note for a major WordPress release cycle label Dec 1, 2020
@sirreal sirreal changed the title Animate: type getAnimateClassName and deprecate component Animate: type getAnimateClassName Dec 1, 2020
@sirreal sirreal merged commit fbb000f into master Dec 1, 2020
@sirreal sirreal deleted the update/deprecate-type-animate branch December 1, 2020 15:46
@github-actions github-actions bot added this to the Gutenberg 9.6 milestone Dec 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants