Skip to content

DataViews: Fix defaultLayouts documentation error #71334

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 2 commits into from
Aug 25, 2025
Merged

DataViews: Fix defaultLayouts documentation error #71334

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fdcfbb
Fix documentation error for DataViews `defaultLayouts`
talldan Aug 25, 2025
432aa6a
Add changelog entry
talldan Aug 25, 2025
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
Next Next commit
Fix documentation error for DataViews defaultLayouts
  • Loading branch information
@talldan
talldan committed Aug 25, 2025
commit 6fdcfbb7ab2ce8e756247ab76e6f6b6a5835840d
6 changes: 3 additions & 3 deletions packages/dataviews/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,9 +358,9 @@ Whether the data is loading. `false` by default.

#### `defaultLayouts`: `Record< string, view >`

This property provides layout information about active view types. If empty, this enables all layout types (see "Layout Types") with empty layout data.
This property limits the available layout and provides layout information about active view types. If empty, this enables all layout types (see "Layout Types") with empty layout data.

For example, this is how you'd enable only the table view type:
For example, this is how you'd enable only the table and grid layout type and set whether those layouts show media by default:

```js
const defaultLayouts = {
Expand All @@ -373,7 +373,7 @@ const defaultLayouts = {
};
```

The `defaultLayouts` property should be an object that includes properties named `table`, `grid`, or `list`. These properties are applied to the view object each time the user switches to the corresponding layout.
The `defaultLayouts` property should be an object that includes properties named `table`, `grid`, and/or `list`. These properties are applied to the view object each time the user switches to the corresponding layout.

#### `selection`: `string[]`

Expand Down
Loading