Skip to content

Add 'length' alias to API docs #23

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

Merged
merged 1 commit into from
Apr 23, 2023
Merged

Add 'length' alias to API docs #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions src/pages/Api.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,13 @@ export default function Api() {
<code>string</code>,
<><p>Automatically begin animating the effect based on where the PushIn container is while scrolling.</p> <p><strong>Options:</strong><ul><li><code>scroll</code> - begin animating immediately when the user begins scrolling.</li><li><code>screen-top</code> - begin animating when the top of the PushIn container aligns with the top of the browser.</li><li><code>screen-bottom</code> - begin animating when the top of the PushIn container aligns with the bottom of the browser.</li></ul></p><p><strong>Default:</strong> <code>'scroll'</code></p></>
),

createData(
'length',
<code>data-pushin-length</code>,
<code>number</code>,
<><p>Alias for <code>layerDepth</code>. When an inpoint and outpoint are not provided for a layer, PushIn will use this number to calculate how long the layer should animate when scrolling. If used in combination with 'continuous' mode, it can indicate how long the effect should scroll on the page.</p><p><strong>Default:</strong> <code>1000</code></p></>
),
];

const sceneRows = [
Expand Down