feat: Public layout component #11705
Annotations
2 errors and 1 warning
Run Unit Tests:
src/__tests__/snapshot-tests/documenter.test.ts#L8
expect(received).toMatchSnapshot(hint)
Snapshot name: `Documenter definition for page-layout matches the snapshot: page-layout 1`
- Snapshot - 4
+ Received + 44
@@ -1,8 +1,49 @@
{
"events": [],
- "functions": [],
+ "functions": [
+ {
+ "description": "Manually closes the navigation drawer if it is necessary for the current
+ viewport size.",
+ "name": "closeNavigationIfNecessary",
+ "parameters": [],
+ "returnType": "void",
+ },
+ {
+ "description": "Focuses the active drawer. Use this to focus the active drawer after opening it programmatically.",
+ "name": "focusActiveDrawer",
+ "parameters": [],
+ "returnType": "void",
+ },
+ {
+ "description": "Focuses the navigation. Use this to focus the navigation after opening it programmatically.",
+ "name": "focusNavigation",
+ "parameters": [],
+ "returnType": "void",
+ },
+ {
+ "description": "Focuses the split panel if it is open.",
+ "name": "focusSplitPanel",
+ "parameters": [],
+ "returnType": "void",
+ },
+ {
+ "description": "Focuses the tools panel if it is open. Use this to focus the tools panel
+ after changing the content, for example when clicking on an 'info' link while
+ the panel is already open.",
+ "name": "focusToolsClose",
+ "parameters": [],
+ "returnType": "void",
+ },
+ {
+ "description": "Opens the tools panel if it is not already open. Note that it is preferable
+ to control the state by listening to `toolsChange` and providing `toolsOpen`.",
+ "name": "openTools",
+ "parameters": [],
+ "returnType": "void",
+ },
+ ],
"name": "PageLayout",
"properties": [
{
"description": "Drawers property. If you set both `drawers` and `tools`, `drawers` will take precedence.
Each Drawer is an item in the drawers wrapper with the following properties:
@@ -29,13 +70,12 @@
"name": "drawers",
"optional": true,
"type": "Array<PageLayoutProps.Drawer>",
},
{
- "description": "If `true`, the navigation trigger is not displayed at all,
- while navigation drawer might be displayed, but opened using a custom trigger.",
- "name": "navigationTriggerHide",
+ "description": "If `true`, the toolbar is not displayed at all.",
+ "name": "toolbarHide",
"optional": true,
"type": "boolean",
},
],
"regions": [],
at src/__tests__/snapshot-tests/documenter.test.ts:8:24
|
Run Unit Tests
Process completed with exit code 1.
|
ubuntu-latest pipelines will use ubuntu-24.04 soon. For more details, see https://github.com/actions/runner-images/issues/10636
|
Loading