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

docs(Splash): document splashFullScreen and splashImmersive config options #2613

Merged
merged 1 commit into from
Mar 23, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion site/docs-md/apis/splash-screen/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,10 @@ To set the color of the spinner use `spinnerColor`, values are either `#RGB` or

Then run `npx cap copy` to apply these changes.

## Full Screen & Immersive

You can enable `splashFullScreen` to hide status bar, or `splashImmersive` to hide both status bar and software navigation buttons.

## Configuration

These config parameters are available in `capacitor.config.json`:
Expand All @@ -124,7 +128,9 @@ These config parameters are available in `capacitor.config.json`:
"androidSpinnerStyle": "large",
"iosSpinnerStyle": "small",
"spinnerColor": "#999999",
"showSpinner": true
"showSpinner": true,
"splashFullScreen": true,
"splashImmersive": true
}
}
}
Expand Down