A modeless overlay panel displays more detailed information about an object while still allowing the user to interact with the UI that is behind the panel.
Some of the general use cases for the modeless overlay might include:
- If the user needs to access more detailed information from a list or dashboard.
- If the user needs more detailed information while still needing access to the underlying UI.
- Quick access to details without leaving a main page.
- A substitute for a modal overlay when the underlying UI directly affects the surfaced details.
Some of the more detailed use cases for the modeless overlay might include:
- This pattern should be used only for detailed or secondary information, primary information should not live on this panel.
- The underlying information should be directly related to the detailed information that is surfaced on the panel.
- This pattern could be used to add, view, edit, and remove detailed information of an individual item.
Notes about the behavior of the modeless overlay panel:
- The overlay panel can be collapsed and there’s a slight animation that goes along with it when the user closes the panel.
- The text boxes and fields featured on the overlay panel allow the user to edit them inline.
- The overlay panel never bleeds onto the top navigation, it rests directly underneath of it.
- There is a slight shadow that appears around the edge of the overlay panel to reinforce that it is on another layer.
- The user can still access the UI layer underneath of the overlay panel when the panel is extended.
Modeless Overlay Example
Usage Scenario The modeless overlay is a pattern that can be used as a replacement for a traditional modal. The modeless overlay can be used in scenarios in which a user may have to access secondary actions or information in order to complete a task. The information and actions on the modeless overlay are directly connected to the main underlying UI and allow the user to still interact with this underlying UI even when the modeless overlay is expanded.
Animation Whenever the modeless overlay panel is expanded or collapsed, there is a subtle sliding motion that accompanies it. The panel glides in and out of the side of the underlying UI that it is anchored to.
Accessing the Overlay Panel The user can access the overlay panel by creating a new object, editing a line of text, selecting an object, or other actions from an access point featured on the main underlying UI.
Overlay Panel: The panel itself rests right along the bottom of the top navigation but does not bleed onto the top navigation bar. There is a slight shadow around the overlay panel that helps to reinforce that it is located on top of the main page. The panel may be anchored to one side of the underlying UI (top, left, right, or bottom). The overlay panel should not cover any persistent navigational elements such as a top or side navigation bar.
Close Button: The close button allows the user to dismiss the overlay pattern. When the panel is closed, there is a slight animation that shows the overlay panel sliding back into the side it was anchored on.
Title Area: The primary name of the selected object helps to identify what is being shown on the panel and is featured at the top of the panel.
Content Area: Object specific content such as descriptive title, date, status, product owner, collaborators, description, etc. could live here.
View Full Page: If a user needs to view the details featured on the panel in a larger environment, the user can extend the panel to be a full page. Once the full page has been activated, the user can get back to the standard view of the overlay panel by clicking on a button entitled “View Standard Page”. This will return the modeless overlay back to its original state.
- Content Body: The overlay panel may be used with a variety of different views such as list, table, or card view. When using the overlay panel in different types of content views, the user still has the ability to interact with the page underneath of the panel and can adjust the content of the panel by selecting a different object from the underlying page.
Vertical Navigation: If the content of the panel extends past the initial frame of the window a vertical scrollbar should be enabled.
Horizontal Scrollbar: In the case of the modeless overlay panel, a horizontal scrollbar should not be used.
Modeless Overlay- Mobile
Overlay Panel Behavior: On mobile, the overlay panel would extend out to be full screen. The overlay panel should act as an extension of the underlying UI. It presents more detailed information about an object that was featured in the underlying UI. When the overlay panel is open, it should be the only element that the user can interact with. In order to access the underlying UI, the user must exit the overlay panel.
Accessing the Overlay Panel: On mobile, the user can access the overlay panel by creating a new object, editing a line of text, selecting an object, or other actions from the main underlying UI.
Object Specific Content: Within each object, the user can input and attach object specific content.
Selecting Object Content: When the underlying UI is populated with object content, the user can select an individual object and open the overlay panel that way. The overlay panel will show information regarding the selected object.
Object Content: The user can view general object information from the overlay panel.
PatternFly Core Example Not Available
There is no PatternFly-Core code available for this pattern at this time. Links to the JS framework implementations can be seen above.
Visit the Contributing to PatternFly documentation to learn how to contribute the code.