Skip to content

Commit ad084f6

Browse files
committed
fix documentation
1 parent 6ff88e3 commit ad084f6

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

packages/model-viewer/src/features/loading.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,8 +205,8 @@ export const LoadingMixin = <T extends Constructor<ModelViewerElementBase>>(
205205
*
206206
* The default value is "auto". The only supported alternative values are
207207
* "lazy" and "eager". Auto is equivalent to lazy, which loads the model
208-
* when it is near the viewport for reveal = "auto", and when interacted
209-
* with for reveal = "interaction". Eager loads the model immediately.
208+
* when it is near the viewport for reveal = "auto", and when dismissPoster()
209+
* is called for reveal = "manual". Eager loads the model immediately.
210210
*/
211211
@property({type: String})
212212
loading: LoadingAttributeValue = LoadingStrategy.AUTO;

packages/modelviewer.dev/data/docs.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
{
4343
"name": "loading",
4444
"htmlName": "loading",
45-
"description": "An enumerable attribute describing under what conditions the model should be preloaded. The supported values are \"auto\", \"lazy\" and \"eager\". Auto is equivalent to lazy, which loads the model when it is near the viewport for <span class='attribute'>reveal=\"auto\"</span>, and when interacted with for <span class='attribute'>reveal=\"interaction\"</span>. Eager loads the model immediately.",
45+
"description": "An enumerable attribute describing under what conditions the model should be preloaded. The supported values are \"auto\", \"lazy\" and \"eager\". Auto is equivalent to lazy, which loads the model when it is near the viewport for <span class='attribute'>reveal=\"auto\"</span>, and when <span class='attribute'>dismissPoster()</span> is called for <span class='attribute'>reveal=\"manual\"</span>. Eager loads the model immediately.",
4646
"links": [
4747
"<a href=\"../examples/loading/\">Related examples</a>"
4848
],
@@ -181,7 +181,7 @@
181181
{
182182
"name": "showPoster()",
183183
"htmlName": "showPoster",
184-
"description": "Shows the <span class='attribute'>poster</span>, hiding the model. If this is called after the 3D model has been revealed, then it will behave as though <span class='attribute'>reveal='interaction'</span>, being dismissed either by a user click or a call to dismissPoster()."
184+
"description": "Shows the <span class='attribute'>poster</span>, hiding the model. If this is called after the 3D model has been revealed, then it must be dismissed by a call to <span class='attribute'>dismissPoster()</span>."
185185
},
186186
{
187187
"name": "getDimensions()",

0 commit comments

Comments
 (0)