Skip to content

Commit 141e3a3

Browse files
committed
moved documentation update commit from other branch
1 parent f7900a3 commit 141e3a3

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

website/docs/components/app-side-nav/partials/code/component-api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ This is the full-fledged component (responsive and animated).
2121
<C.Property @name="isMinimized" @type="boolean" @default="false">
2222
Controls if the App Side Nav is rendered collapsed or expanded when initialized. This allows an application to preserve the collapsed/expanded state across sessions. After the initial render, this argument is altered based on user interactions (collapse/expand the App Side Nav or resize the window) and it is not a suitable way of controlling the App Side Nav state from outside after render (it’s an internal state).
2323
</C.Property>
24+
<C.Property @name="breakpoint" @type="string" @default="1088px">
25+
Set a custom breakpoint to control the page width at which the UI switches from displaying the mobile/small view vs. the desktop/view.
26+
</C.Property>
2427
<C.Property @name="onToggleMinimizedStatus" @type="function">
2528
Callback function invoked when the `AppSideNav` is collapsed or expanded. The function receives a boolean argument stating if the `AppSideNav` is minimized or not.
2629
</C.Property>

website/docs/components/app-side-nav/partials/code/how-to-use.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Below is an example (inspired by the Cloud UI navigation) of how the two kinds o
118118

119119
<!-- ```handlebars
120120
{{!--
121-
for demo purposes we set `@isResponsive` to `false` but in your app it will probably need to be set to `true`
121+
for demo purposes we set `@isResponsive` to `false` but in your app it will probably need to be set to `true`
122122
(or omitted to rely on defaults)
123123
--}}
124124
<div class="doc-app-sidenav-demo--cloud-ui">
@@ -175,7 +175,7 @@ When the App Side Nav is used in conjunction with portals, the nesting of naviga
175175
As mentioned above, the full-fledged `Hds::AppSideNav` component is “responsive” by default:
176176

177177
- when the **viewport is `desktop`**, the sidebar navigation is static and has a fixed width
178-
- the width at which the viewport is considered “desktop” is controlled by a dedicated CSS variable `--hds-app-desktop-breakpoint`; if needed it can be overwritten (at `:root` level) to define a custom “desktop” breakpoint
178+
- the width at which the viewport is considered “desktop” can be overwritten using the `@breakpoint` argument
179179
- when the **viewport is `mobile`**, the sidebar navigation is responsive and the user can minimize or maximize its width via a toggle button (the component will take care automatically of the transitions between these two states)
180180
- in this case the App Side Nav occupies only a minimum width in terms of page layout, even when expanded (it partially covers the main content)
181181
- a toggle button is added to the App Side Nav, used to expand/minimize its width

0 commit comments

Comments
 (0)