Added section for appdrawertoggle, drawer actions and drawer title in the applayout documentation. #321
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
EHandtkeBasis
requested review from
hyyan,
MatthewHawkins,
nmlynx and
mschned
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
5 tasks
EHandtkeBasis
changed the title
This was
linked to
issues
May 9, 2025
|
Relying on #299 to be merged first for final revision. |
EHandtkeBasis
force-pushed
the
appdrawertoggle
branch
from
80b9373 to
2227a11
Compare
|
@MatthewHawkins please give it a quick read over for language/style |
bbrennanbasis
requested changes
Jun 25, 2025
There was a problem hiding this comment.
@EHandtkeBasis I've left some review comments. Additional, please rebase the branch and resolve the merge conflicts.
docs/docs/components/app-layout.md
Outdated
Comment on lines
98
to
112
| ## Drawer breakpoint | ||
|
|
||
| Be default, when the screen width is 800px or less , the drawer will be switched to popover mode. This is called the breakpoint. Popover mode means that the drawer will pop over the content area with an overlay. It is possible to configure the breakpoint by using the DwcAppLayout:setDrawerBreakpoint method and the breakpoint must be a valid media query. | ||
| Be default, when the screen width is 800px or less , the drawer will be switched to popover mode. This is called the breakpoint. Popover mode means that the drawer will pop over the content area with an overlay. It's possible to configure the breakpoint by using the DwcAppLayout:setDrawerBreakpoint method and the breakpoint must be a valid media query. | ||
|
|
||
| For instance, in the following sample. we configure the drawer breakpoint to be 500px or less. | ||
| For instance, in the following sample the drawer breakpoint is configured to be 500px or less. | ||
|
|
||
| ```java | ||
| AppLayout demo = new AppLayout(); | ||
| demo.setDrawerBreakpoint("(max-width:500px)"); | ||
| ``` | ||
|
|
||
| <AppLayoutViewer path='/webforj/applayoutmobiledrawer/?' mobile='true' | ||
| <!-- <AppLayoutViewer path='/webforj/applayoutmobiledrawer/?' mobile='true' | ||
| javaE='https://raw.githubusercontent.com/webforj/webforj-documentation/refs/heads/main/src/main/java/com/webforj/samples/views/applayout/AppLayoutMobileDrawerView.java' | ||
| cssURL='https://raw.githubusercontent.com/webforj/webforj-documentation/main/src/main/resources/css/applayout/applayoutMobile.css' | ||
| /> --> |
There was a problem hiding this comment.
Move this to be a sub section under Drawer utilities.
docs/docs/components/app-layout.md
Outdated
| javaE='https://raw.githubusercontent.com/webforj/webforj-documentation/refs/heads/main/src/main/java/com/webforj/samples/views/applayout/AppLayoutMobileDrawerView.java' | ||
| cssURL='https://raw.githubusercontent.com/webforj/webforj-documentation/main/src/main/resources/css/applayout/applayoutMobile.css' | ||
| /> --> | ||
|
|
||
| ## Drawer utilities |
There was a problem hiding this comment.
Suggestion: Add a sentence here distinguishing the drawer utility inside the AppLayout component vs the standalone Drawer component.
...a/com/webforj/samples/views/applayout/applayoutdrawerutility/AppLayoutDrawerUtilityView.java
Show resolved
Hide resolved
bbrennanbasis
requested changes
Jun 26, 2025
docs/docs/components/app-layout.md
Outdated
| <AppLayoutViewer path='/webforj/applayoutfullnavbar/content/Dashboard?' mobile='false' | ||
| javaE='https://raw.githubusercontent.com/webforj/webforj-documentation/refs/heads/main/src/main/java/com/webforj/samples/views/applayout/fullnavbar/AppLayoutFullNavbarView.java' | ||
| cssURL='https://raw.githubusercontent.com/webforj/webforj-documentation/main/src/main/resources/css/applayout/applayout.css'/> | ||
|
|
||
|
|
||
| --> |
There was a problem hiding this comment.
Remove each --> from previously commented out examples.
docs/docs/components/app-layout.md
Outdated
|
|
||
| ### Drawer actions | ||
|
|
||
| The `AppLayout` component allows you to place custom components such as buttons or icons into the **drawer header actions area** using the `addToDrawerHeaderActions(...)` method. |
There was a problem hiding this comment.
Don't use ellipsis inside the methods -> addToDrawerHeaderActions()
docs/docs/components/app-layout.md
Outdated
|
|
||
| Be default, when the screen width is 800px or less , the drawer will be switched to popover mode. This is called the breakpoint. Popover mode means that the drawer will pop over the content area with an overlay. It is possible to configure the breakpoint by using the DwcAppLayout:setDrawerBreakpoint method and the breakpoint must be a valid media query. | ||
| The AppLayout drawer utility is designed for integrated navigation and contextual menus within the main app layout, while standalone Drawer components offer flexible, independent sliding panels that can be used anywhere in your app for additional content, filters, or notifications. This section focuses on the built-in drawer features and utilities provided by AppLayout. |
There was a problem hiding this comment.
Put AppLayout and Drawer in code brackets. Also, link to the Drawer article: https://docs.webforj.com/docs/components/drawer
Comment on lines
120
to
+113
|
|
||
| <AppLayoutViewer path='/webforj/applayoutmobiledrawer/?' mobile='true' | ||
| javaE='https://raw.githubusercontent.com/webforj/webforj-documentation/refs/heads/main/src/main/java/com/webforj/samples/views/applayout/mobiledrawer/AppLayoutMobileDrawerView.java' | ||
| cssURL='https://raw.githubusercontent.com/webforj/webforj-documentation/main/src/main/resources/css/applayout/applayoutMobile.css' | ||
| ### Drawer title |
There was a problem hiding this comment.
Please remove the AppLayoutMobileDrawerView java class file if this example is no longer used in the articles.
MatthewHawkins
approved these changes
Jul 9, 2025
bbrennanbasis
approved these changes
Jul 15, 2025
bbrennanbasis
force-pushed
the
appdrawertoggle
branch
from
cf97047 to
a315fda
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.