Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: Kiosk Mode and URL Params #38938

Closed
wants to merge 13 commits into from

Conversation

w33ble
Copy link
Contributor

@w33ble w33ble commented Jun 13, 2019

Summary

Closes #23061
Closes #23144
Closes #29526

All those issues are basically asking for the same thing.

This PR introduces "app state" to Canvas, which is used to control fullscreen mode, auto-playing, and auto-refresh from the URL. This works similar to how Kibana core works, where app state is rison-encoded and added to the _a search param in the URL. So you'll now see something like the following appended to URLs:

?_a=(autoplay%3A(enabled%3A!t%2Cinterval%3A2000)%2Cautorefresh%3A(interval%3A0)%2Cfullscreen%3A!f)

App state is controlled through a new app_state lib which exposes methods for reading from and updating app state. This module is used in middleware to update app state, and also in the router component to set redux state based on the initial values in the URL.

Usage

You should see no change to the URL the first time you load Canvas. Once you enable fullscreen, or enable/modify the auto-refresh or auto-play settings, you'll see these settings in the url. For example, toggling fullscreen will result in ?_a=(fullscreen%3A!t) being appended. Hit escape to leave fullscreen mode and you will see the updated state reflected as ?_a=(fullscreen%3A!f) (note the !t became !f, both rison-encoded values).

@w33ble w33ble added the loe:medium Medium Level of Effort label Jun 13, 2019
@elastic elastic deleted a comment from elasticmachine Jun 13, 2019
@elastic elastic deleted a comment from elasticmachine Jun 13, 2019
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

no need to muddy up the url if the appState is the default value
@w33ble w33ble force-pushed the feat/kiosk-url-params branch from 8f1db55 to ac1964b Compare June 14, 2019 17:09
@w33ble w33ble added release_note:enhancement Feature:New Feature New feature not correlating to an existing feature label v7.3.0 v8.0.0 labels Jun 14, 2019
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:New Feature New feature not correlating to an existing feature label loe:medium Medium Level of Effort release_note:enhancement v7.3.0 v8.0.0
Projects
None yet
3 participants