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.

Sign up for GitHub

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

Jump to bottom

Remove the screenshots_enabled setting flag #44

Merged
merged 1 commit into from
May 21, 2024
Merged

Remove the screenshots_enabled setting flag #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 0 additions & 3 deletions core/src/main/kotlin/dev/hotwire/core/turbo/config/PathConfiguration.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,3 @@ val PathConfigurationProperties.title: String?

val PathConfigurationProperties.pullToRefreshEnabled: Boolean
get() = get("pull_to_refresh_enabled")?.toBoolean() ?: false

val PathConfigurationSettings.screenshotsEnabled: Boolean
get() = get("screenshots_enabled")?.toBoolean() ?: true
2 changes: 0 additions & 2 deletions core/src/main/kotlin/dev/hotwire/core/turbo/delegates/TurboWebFragmentDelegate.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,8 +373,6 @@ internal class TurboWebFragmentDelegate(
}

private fun screenshotView() {
if (!session.screenshotsEnabled) return

turboView?.let {
screenshot = it.createScreenshot()
screenshotOrientation = it.screenshotOrientation()
Expand Down
8 changes: 0 additions & 8 deletions core/src/main/kotlin/dev/hotwire/core/turbo/session/Session.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ import androidx.webkit.WebResourceErrorCompat
import androidx.webkit.WebViewClientCompat
import androidx.webkit.WebViewCompat
import androidx.webkit.WebViewFeature.*
import dev.hotwire.core.config.Hotwire.pathConfiguration
import dev.hotwire.core.lib.logging.logEvent
import dev.hotwire.core.turbo.config.screenshotsEnabled
import dev.hotwire.core.turbo.delegates.TurboFileChooserDelegate
import dev.hotwire.core.turbo.errors.HttpError
import dev.hotwire.core.turbo.errors.LoadError
Expand Down Expand Up @@ -64,12 +62,6 @@ class Session internal constructor(
*/
var offlineRequestHandler: TurboOfflineRequestHandler? = null

/**
* Returns whether transitional screenshots are enabled for this session. Default is `true`.
*/
val screenshotsEnabled
get() = pathConfiguration.settings.screenshotsEnabled

/**
* Gets the nav destination that corresponds to the current WebView visit.
*/
Expand Down
4 changes: 1 addition & 3 deletions demo/src/main/assets/json/configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"settings": {
"screenshots_enabled": true
},
"settings": {},
"rules": [
{
"patterns": [
Expand Down
10 changes: 2 additions & 8 deletions docs/PATH-CONFIGURATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ In its simplest form, your JSON configuration will look like:
**`assets/json/configuration.json`:**
```json
{
"settings": {
"screenshots_enabled": true
},
"settings": {},
"rules": [
{
"patterns": [
Expand Down Expand Up @@ -53,11 +51,7 @@ Here's some tips for managing path configurations:
- Try to keep your local and remote path configuration files in sync. When your app starts, Turbo will load your local configuration file, then make a request for your remote file which will override your local file. If the files are different and your server doesn't respond quickly, it's possible to get difficult to debug behaviour. If you're making other changes to your app that will require a new native deployment, that's a good time to update your local file to match the current state of your server.

## Settings
The `settings` object is a place to configure app-level settings. This is useful when you have a remote configuration file, since you can add your own custom settings and use them as remote feature-flags. Available settings are:
* `screenshots_enabled` — Whether or not transitional web screenshots should be used during navigation. This gives the appearance of a more smooth experience since the session WebView is swapped between web destination Fragments, but does require more performance overhead.
* Optional.
* Possible values: `true`, `false`. Defaults to `true`.
* Any custom app settings that you'd like to configure here
The `settings` object is a place to configure app-level settings. This is useful when you have a remote configuration file, since you can add your own custom settings and use them as remote feature-flags. You can provide any custom app settings that you'd like to configure here.

## Rules
The `"rules"` array defines a list of rules that are processed in order and cascade downward, similar to CSS. The top-most declaration should establish the default behavior for all url path patterns, while each subsequent rule can override for specific behavior.
Expand Down
Loading