[amp-stories sub-task] Add front-end animation. #1385
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,6 +39,84 @@ var ampStoryEditorBlocks = ( function() { // eslint-disable-line no-unused-vars | |
| value: 'lower-third', | ||
| label: __( 'Lower Third', 'amp' ) | ||
| } | ||
| ], | ||
| ampAnimationTypeOptions: [ | ||
| { | ||
| value: '', | ||
| label: __( 'None', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'drop', | ||
| label: __( 'Drop', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'fade-in', | ||
| label: __( 'Fade In', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'fly-in-bottom', | ||
| label: __( 'Fly In Bottom', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'fly-in-left', | ||
| label: __( 'Fly In Left', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'fly-in-right', | ||
| label: __( 'Fly In Right', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'fly-in-top', | ||
| label: __( 'Fly In Top', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'pulse', | ||
| label: __( 'Pulse', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'rotate-in-left', | ||
| label: __( 'Rotate In Left', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'rotate-in-right', | ||
| label: __( 'Rotate In Right', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'twirl-in', | ||
| label: __( 'Twirl In', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'whoosh-in-left', | ||
| label: __( 'Whoosh In Left', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'whoosh-in-right', | ||
| label: __( 'Whoosh In Right', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'pan-left', | ||
| label: __( 'Pan Left', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'pan-right', | ||
| label: __( 'Pan Right', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'pan-down', | ||
| label: __( 'Pan Down', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'pan-up', | ||
| label: __( 'Pan Up', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'zoom-in', | ||
| label: __( 'Zoom In', 'amp' ) | ||
| }, | ||
| { | ||
| value: 'zoom-out', | ||
| label: __( 'Zoom Out', 'amp' ) | ||
| } | ||
| ] | ||
| } | ||
| }; | ||
|
|
@@ -119,6 +197,16 @@ var ampStoryEditorBlocks = ( function() { // eslint-disable-line no-unused-vars | |
| if ( attributes.ampStoryPosition ) { | ||
| ampAttributes[ 'grid-area' ] = attributes.ampStoryPosition; | ||
| } | ||
| if ( attributes.ampAnimationType ) { | ||
| ampAttributes[ 'animate-in' ] = attributes.ampAnimationType; | ||
|
|
||
| if ( attributes.ampAnimationDelay ) { | ||
| ampAttributes[ 'animate-in-delay' ] = attributes.ampAnimationDelay + 'ms'; | ||
| } | ||
| if ( attributes.ampAnimationDuration ) { | ||
| ampAttributes[ 'animate-in-duration' ] = attributes.ampAnimationDuration + 'ms'; | ||
| } | ||
| } | ||
|
|
||
| return _.extend( ampAttributes, props ); | ||
| }; | ||
|
|
@@ -131,14 +219,26 @@ var ampStoryEditorBlocks = ( function() { // eslint-disable-line no-unused-vars | |
| * @return {Object} Settings. | ||
| */ | ||
| component.addAMPAttributes = function addAMPAttributes( settings, name ) { | ||
| // Add the "thirds" template position option and animation settings. | ||
| if ( -1 !== component.data.allowedBlocks.indexOf( name ) ) { | ||
| if ( ! settings.attributes ) { | ||
| settings.attributes = {}; | ||
| } | ||
| settings.attributes.ampStoryPosition = { | ||
| type: 'string' | ||
| }; | ||
| // @todo We could map all the blocks to their tag and use attribute as source instead. | ||
|
There was a problem hiding this comment. Yes, this would be good. Is it not done at the moment because AMP requires the value to have the time unit, e.g. Maybe the hpq library allows a custom Or, if There was a problem hiding this comment. Or maybe it's rather because we don't know the element name to select? There was a problem hiding this comment. Changed these settings to |
||
| settings.attributes.ampAnimationType = { | ||
| type: 'string' | ||
| }; | ||
| settings.attributes.ampAnimationDelay = { | ||
| type: 'number', | ||
| default: 0 | ||
| }; | ||
| settings.attributes.ampAnimationDuration = { | ||
| type: 'number', | ||
| default: 0 | ||
| }; | ||
| } | ||
| return settings; | ||
| }; | ||
|
|
@@ -183,27 +283,28 @@ var ampStoryEditorBlocks = ( function() { // eslint-disable-line no-unused-vars | |
| } | ||
|
|
||
| if ( 'thirds' !== parentBlock.attributes.template ) { | ||
| inspectorControls = el( InspectorControls, { key: 'inspector' }, | ||
| el( PanelBody, { title: __( 'AMP Story Settings', 'amp' ), key: 'amp-story' }, | ||
| component.getAnimationControls( props ) | ||
| ) | ||
| ); | ||
| } else { | ||
| inspectorControls = el( InspectorControls, { key: 'inspector' }, | ||
| el( PanelBody, { title: __( 'AMP Story Settings', 'amp' ), key: 'amp-story' }, | ||
| el( SelectControl, { | ||
| key: 'position', | ||
| label: __( 'Placement', 'amp' ), | ||
| value: attributes.ampStoryPosition, | ||
| options: component.data.ampStoryPositionOptions, | ||
| onChange: function( value ) { | ||
| props.setAttributes( { ampStoryPosition: value } ); | ||
| } | ||
| } ), | ||
| component.getAnimationControls( props ) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| return [ | ||
| inspectorControls, | ||
| el( BlockEdit, _.extend( { | ||
|
|
@@ -213,5 +314,44 @@ var ampStoryEditorBlocks = ( function() { // eslint-disable-line no-unused-vars | |
| }; | ||
| }; | ||
|
|
||
| component.getAnimationControls = function getAnimationControls( props ) { | ||
| var RangeControl = wp.components.RangeControl, | ||
| el = wp.element.createElement, | ||
| SelectControl = wp.components.SelectControl, | ||
| attributes = props.attributes; | ||
|
|
||
| return [ | ||
| el( SelectControl, { | ||
| key: 'animation-type', | ||
| label: __( 'Animation type', 'amp' ), | ||
| value: attributes.ampAnimationType, | ||
| options: component.data.ampAnimationTypeOptions, | ||
| onChange: function( value ) { | ||
| props.setAttributes( { ampAnimationType: value } ); | ||
| } | ||
| } ), | ||
| el( RangeControl, { | ||
| key: 'animation-duration', | ||
| label: __( 'Animation duration (ms)', 'amp' ), | ||
| value: attributes.ampAnimationDuration, | ||
| min: 0, | ||
| max: 5000, | ||
| onChange: function( value ) { | ||
| props.setAttributes( { ampAnimationDuration: value } ); | ||
| } | ||
| } ), | ||
| el( RangeControl, { | ||
| key: 'animation-delay', | ||
| label: __( 'Animation delay (ms)', 'amp' ), | ||
| value: attributes.ampAnimationDelay, | ||
| min: 0, | ||
| max: 5000, | ||
| onChange: function( value ) { | ||
| props.setAttributes( { ampAnimationDelay: value } ); | ||
| } | ||
| } ) | ||
| ]; | ||
| }; | ||
|
|
||
| return component; | ||
| }() ); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This list is duplicated with the array in
getAmpStoryAnimationControls, is it not? I think there should be a commongetAnimationTypeOptionsfunction in theutilsmodule to eliminate this duplication. Even if the list is not exactly the same, the function could still return the full list and then you couldfilterout the ones that aren't allowed.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it is duplicated, however, the
utils.jsgets compiled, not sure what would be the best way to use the module like this withinamp-story-editor-blocks.js, thoughts?Created a separate helpers file for AMP Stories specifically within 4923569 since the
utils.jsalways gets enqueued, however,getAmpStoryAnimationControlsis needed for AMP Stories post type only, thought that then maybe we could add an inline script for defining thegetAnimationTypeOptionsglobally to avoid duplication but not sure if that would be a good way to go.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, right. So this is actually dependent on #1298 which will convert
amp-story-editor-blocks.jsinto a module. So once that happens then this problem would go away, right?