Skip to content

Commit 88a1833

Browse files
authored
Merge pull request #23 from nateplusplus/staging
Add 'length' alias to API docs
2 parents cbaace0 + a6c1203 commit 88a1833

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/pages/Api.jsx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,13 @@ export default function Api() {
119119
<code>string</code>,
120120
<><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></>
121121
),
122+
123+
createData(
124+
'length',
125+
<code>data-pushin-length</code>,
126+
<code>number</code>,
127+
<><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></>
128+
),
122129
];
123130

124131
const sceneRows = [

0 commit comments

Comments
 (0)