Developer Docs - Mobile Docs - Cover Sheet

The ins and outs of displaying and styling cover sheets

v4.0

Cover sheets are a commonly patterned way to present information to a user that doesn't rely on changing the navigation stack.

Cover sheets cannot be opened within cover sheets. Some blocks utilize cover sheets to reveal content or forms, so be sure not to include these blocks in the navigation stack.

Android

Currently, there is not a ton of Android functionality. It works similarly to a PushPage but has an animation that slides from bottom to top instead of from right to left.

If you set IsNavigationPage to false, Android users won't have a way to close the cover sheet. You'll need a custom button that uses the CloseCoverSheet command.  

Parameters

Listed below are the options provided via the ShowCoverSheetCommandParameters object.

Styling

v5.0

You can style the Navigation Bar itself by targeting the cover-sheet class. For example, if you want to change the background bar color, text color, and remove the FullScreen separator:

.cover-sheet {
    -maui-bar-background-color: green;
    -maui-bar-text-color: #ffffff;
    -rock-status-bar-text: light;
    -rock-ios-hide-navigation-bar-separator: true;
}

Setting -rock-ios-hide-navigation-bar-separator: true; works on initial page loads, but changing the OS theme will reveal this separator on the current page.

Examples

To show a cover sheet that displays another page, pass in the PageGuid as the CommandParameter.


To show a cover sheet from provided XAML content, pass in the XAML content you want to render inside of the CommandParameter.


Here is an extensive example with most of the ShowCoverSheetParameters properties utilized.

Closing a Cover Sheet

To close any open cover sheet, use the CloseCoverSheet command.