-
-
Notifications
You must be signed in to change notification settings - Fork 18
Convert Advanced Settings tab to config-r, add QrCode settings (BL-15987) #7730
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
src/BloomBrowserUI/collection/AdvancedSettingsPanel.entry.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| import { bootstrapReactComponent } from "../utils/entryPointBootstrap"; | ||
| import { AdvancedSettingsPanel } from "./AdvancedSettingsPanel"; | ||
|
|
||
| bootstrapReactComponent(AdvancedSettingsPanel); |
222 changes: 222 additions & 0 deletions
222
src/BloomBrowserUI/collection/AdvancedSettingsPanel.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,222 @@ | ||
| import { css } from "@emotion/react"; | ||
| import * as React from "react"; | ||
| import { | ||
| ConfigrBoolean, | ||
| ConfigrGroup, | ||
| ConfigrInput, | ||
| ConfigrPage, | ||
| ConfigrPane, | ||
| } from "@sillsdev/config-r"; | ||
| import { get, postJson } from "../utils/bloomApi"; | ||
| import { kBloomBlue } from "../bloomMaterialUITheme"; | ||
| import { tabMargins } from "./commonTabSettings"; | ||
| import { WireUpForWinforms } from "../utils/WireUpWinform"; | ||
| import { BloomSubscriptionIndicatorIconAndText } from "../react_components/requiresSubscription"; | ||
| import { useGetFeatureStatus } from "../react_components/featureStatus"; | ||
| import { useL10n } from "../react_components/l10nHooks"; | ||
|
|
||
| export const AdvancedSettingsPanel: React.FunctionComponent = () => { | ||
| const [settings, setSettings] = React.useState<object | undefined>( | ||
| undefined, | ||
| ); | ||
| const [showAutoUpdate, setShowAutoUpdate] = React.useState<boolean>(false); | ||
| const [allowTeamCollectionEnabled, setAllowTeamCollectionEnabled] = | ||
| React.useState<boolean>(false); | ||
| const [ | ||
| showExperimentalBookSourcesOption, | ||
| setShowExperimentalBookSourcesOption, | ||
| ] = React.useState<boolean>(false); | ||
|
|
||
| const advancedProgramSettingsLabel = useL10n( | ||
| "Advanced Program Settings", | ||
| "CollectionSettingsDialog.AdvancedTab.AdvancedProgramSettingsTabLabel", | ||
| ); | ||
| const programLabel = useL10n( | ||
| "Program", | ||
| "CollectionSettingsDialog.AdvancedTab.Program", | ||
| ); | ||
| const automaticallyUpdateBloomLabel = useL10n( | ||
| "Automatically Update Bloom", | ||
| "CollectionSettingsDialog.AdvancedTab.AutoUpdate", | ||
| ); | ||
| const showExperimentalBookSourcesLabel = useL10n( | ||
| "Show Experimental Book Sources", | ||
| "CollectionSettingsDialog.AdvancedTab.Experimental.ShowExperimentalBookSources", | ||
| ); | ||
| const teamCollectionsLabel = useL10n( | ||
| "Team Collections", | ||
| "TeamCollection.TeamCollections", | ||
| ); | ||
| const availableWithSubscriptionLabel = useL10n( | ||
| "Available with your Bloom Subscription", | ||
| "AvailableWithSubscription", | ||
| ); | ||
| const qrCodesLabel = useL10n( | ||
| "QR Codes", | ||
| "CollectionSettingsDialog.AdvancedTab.QrCodes", | ||
| ); | ||
| const showQrCodesLabel = useL10n( | ||
| "Show QR Codes", | ||
| "CollectionSettingsDialog.AdvancedTab.ShowQrCodes", | ||
| ); | ||
| const showQrCodesDescription = useL10n( | ||
| "Scanning the code or clicking the badge will take the user to the collection of books in this collection's primary language. Note, if you want to use this but your branding does not show it, contact us.", | ||
| "CollectionSettingsDialog.AdvancedTab.ShowQrCodes.Description", | ||
| ); | ||
| const captionLabel = useL10n( | ||
| "Caption", | ||
| "CollectionSettingsDialog.AdvancedTab.Caption", | ||
| ); | ||
| const captionDescription = useL10n( | ||
| 'If your caption contains "{0}", Bloom will fill this in with the name of the language.', | ||
| "CollectionSettingsDialog.AdvancedTab.Caption.Description", | ||
| ); | ||
|
|
||
| const featureStatus = useGetFeatureStatus("TeamCollection"); | ||
| const teamCollectionOptionEnabled = | ||
| featureStatus === undefined ? true : featureStatus.enabled; | ||
| const canChangeTeamCollectionOption = allowTeamCollectionEnabled !== false; | ||
|
|
||
| const normalizeConfigrSettings = React.useCallback( | ||
| (settingsValue: string | object | undefined): object | undefined => { | ||
| if (!settingsValue) { | ||
| return undefined; | ||
| } | ||
| if (typeof settingsValue === "string") { | ||
| return JSON.parse(settingsValue) as object; | ||
| } | ||
| return settingsValue; | ||
| }, | ||
| [], | ||
| ); | ||
|
|
||
| // Load current advanced settings from the host dialog so Config-r starts with matching values. | ||
| React.useEffect(() => { | ||
| get("settings/advancedProgramSettings", (result) => { | ||
| if (!result || !result.data || result.data === "{}") { | ||
| return; | ||
| } | ||
| let data = result.data; | ||
| if (typeof result.data === "string") { | ||
| data = JSON.parse(result.data); | ||
| } | ||
| setSettings(data["values"]); | ||
| setShowAutoUpdate(data["showAutoUpdate"] ?? false); | ||
| setAllowTeamCollectionEnabled( | ||
| data["allowTeamCollectionEnabled"] ?? false, | ||
| ); | ||
| setShowExperimentalBookSourcesOption( | ||
| data["showExperimentalBookSourcesOption"] ?? false, | ||
| ); | ||
| }); | ||
| }, []); | ||
|
|
||
| return ( | ||
| <div | ||
| css={css` | ||
| display: flex; | ||
| flex-direction: column; | ||
| height: 100%; | ||
| padding-top: ${tabMargins.top}; | ||
| padding-left: ${tabMargins.side}; | ||
| padding-right: ${tabMargins.side}; | ||
| padding-bottom: ${tabMargins.bottom}; | ||
| `} | ||
| > | ||
| {settings && ( | ||
| <ConfigrPane | ||
| label={advancedProgramSettingsLabel} | ||
| showAppBar={false} | ||
| showSearch={false} | ||
| initialValues={ | ||
| settings as React.ComponentProps< | ||
| typeof ConfigrPane | ||
| >["initialValues"] | ||
| } | ||
| themeOverrides={{ | ||
| palette: { | ||
| primary: { main: kBloomBlue }, | ||
| }, | ||
| }} | ||
| onChange={(newSettings) => { | ||
| const normalized = | ||
| normalizeConfigrSettings(newSettings); | ||
| if (normalized) { | ||
| setSettings(normalized); | ||
| postJson( | ||
| "settings/advancedProgramSettings", | ||
| normalized, | ||
| ); | ||
| } | ||
|
devin-ai-integration[bot] marked this conversation as resolved.
|
||
| }} | ||
| > | ||
| <ConfigrPage label={""} pageKey="settings" topLevel={true}> | ||
| <ConfigrGroup label={programLabel}> | ||
| {showAutoUpdate && ( | ||
| <ConfigrBoolean | ||
| label={automaticallyUpdateBloomLabel} | ||
| path="autoUpdate" | ||
| /> | ||
| )} | ||
| {showExperimentalBookSourcesOption && ( | ||
| <ConfigrBoolean | ||
| label={showExperimentalBookSourcesLabel} | ||
| path="showExperimentalBookSources" | ||
| /> | ||
| )} | ||
| <div | ||
| css={css` | ||
| .Mui-disabled { | ||
| // The color already sets opacity to 0.26. We don't | ||
| // want to get any lighter, but MUI defaults to an | ||
| // additional "opacity: 0.38" for disabled elements. | ||
| opacity: 1; | ||
| } | ||
| `} | ||
| > | ||
| <ConfigrBoolean | ||
| label={teamCollectionsLabel} | ||
| path="allowTeamCollection" | ||
| disabled={ | ||
| !teamCollectionOptionEnabled || | ||
| !canChangeTeamCollectionOption | ||
| } | ||
| ></ConfigrBoolean> | ||
| </div> | ||
| <div | ||
| css={css` | ||
| display: flex; | ||
| justify-content: flex-end; | ||
| .bloom-subscriptionIndicator { | ||
| font-size: 10pt; | ||
| font-weight: 700; | ||
| } | ||
| `} | ||
| > | ||
| <BloomSubscriptionIndicatorIconAndText | ||
| feature="TeamCollection" | ||
| className="bloom-subscriptionIndicator" | ||
| /> | ||
| </div> | ||
| </ConfigrGroup> | ||
| <ConfigrGroup label={qrCodesLabel}> | ||
| <ConfigrBoolean | ||
| label={showQrCodesLabel} | ||
| path="showQrCode" | ||
| description={showQrCodesDescription} | ||
| ></ConfigrBoolean> | ||
| <ConfigrInput | ||
| path="qrcodeCaption" | ||
| label={captionLabel} | ||
| description={captionDescription} | ||
| disabled={!settings["showQrCode"]} | ||
| /> | ||
| </ConfigrGroup> | ||
| </ConfigrPage> | ||
| </ConfigrPane> | ||
| )} | ||
| </div> | ||
| ); | ||
| }; | ||
|
|
||
| WireUpForWinforms(AdvancedSettingsPanel); | ||
66 changes: 0 additions & 66 deletions
66
src/BloomBrowserUI/collection/BlorgLanguageQrCodeControl.tsx
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.