Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: add storybook for /deployment/appearance page #5582

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

Merged
merged 5 commits into from
Jan 5, 2023
Merged

feat: add storybook for /deployment/appearance page #5582

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
784e274
wip
jsjoeio Jan 4, 2023
e0946ce
wip: move appearancesettingspage
jsjoeio Jan 4, 2023
8da6899
refactor: separate page and view ApperanceSettings
jsjoeio Jan 5, 2023
9f2f9a5
refactor: create storybook from AppearanceSettingsView
jsjoeio Jan 5, 2023
1c9deaa
fixup: formatting and types
jsjoeio Jan 5, 2023
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
Prev Previous commit
Next Next commit
refactor: separate page and view ApperanceSettings
  • Loading branch information
@jsjoeio
jsjoeio committed Jan 5, 2023
commit 8da68992f2d0865dfc4dd2685053f30a8fd4023a
234 changes: 6 additions & 228 deletions site/src/pages/DeploySettingsPage/AppearanceSettingsPage/AppearanceSettingsPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,11 @@
import Button from "@material-ui/core/Button"
import FormControlLabel from "@material-ui/core/FormControlLabel"
import FormHelperText from "@material-ui/core/FormHelperText"
import InputAdornment from "@material-ui/core/InputAdornment"
import { useTheme } from "@material-ui/core/styles"
import makeStyles from "@material-ui/core/styles/makeStyles"
import Switch from "@material-ui/core/Switch"
import TextField from "@material-ui/core/TextField"
import { useActor } from "@xstate/react"
import { FeatureNames } from "api/types"
import { AppearanceConfig } from "api/typesGenerated"
import {
Badges,
DisabledBadge,
EnterpriseBadge,
EntitledBadge,
} from "components/DeploySettingsLayout/Badges"
import { Fieldset } from "components/DeploySettingsLayout/Fieldset"
import { Header } from "components/DeploySettingsLayout/Header"
import { Stack } from "components/Stack/Stack"
import { useFormik } from "formik"
import React, { useContext, useState } from "react"
import { BlockPicker } from "react-color"
import React, { useContext } from "react"
import { Helmet } from "react-helmet-async"
import { useTranslation } from "react-i18next"
import { getFormHelpers } from "util/formUtils"
import { pageTitle } from "util/page"
import { XServiceContext } from "xServices/StateContext"
import { AppearanceSettingsPageView } from "./AppearanceSettingsPageView"

// ServiceBanner is unlike the other Deployment Settings pages because it
// implements a form, whereas the others are read-only. We make this
Expand All @@ -38,7 +18,6 @@ const AppearanceSettingsPage: React.FC = () => {
)
const [entitlementsState] = useActor(xServices.entitlementsXService)
const appearance = appearanceXService.context.appearance
const styles = useStyles()

const isEntitled =
entitlementsState.context.entitlements.features[FeatureNames.Appearance]
Expand All @@ -65,220 +44,19 @@ const AppearanceSettingsPage: React.FC = () => {
})
}

const logoForm = useFormik<{
logo_url: string
}>({
initialValues: {
logo_url: appearance.logo_url,
},
onSubmit: (values) => updateAppearance(values, false),
})
const logoFieldHelpers = getFormHelpers(logoForm)

const serviceBannerForm = useFormik<AppearanceConfig["service_banner"]>({
initialValues: {
message: appearance.service_banner.message,
enabled: appearance.service_banner.enabled,
background_color: appearance.service_banner.background_color,
},
onSubmit: (values) =>
updateAppearance(
{
service_banner: values,
},
false,
),
})
const serviceBannerFieldHelpers = getFormHelpers(serviceBannerForm)
const [backgroundColor, setBackgroundColor] = useState(
serviceBannerForm.values.background_color,
)

const theme = useTheme()
const [t] = useTranslation("appearanceSettings")

return (
<>
<Helmet>
<title>{pageTitle("Appearance Settings")}</title>
</Helmet>

<Header
title="Appearance"
description="Customize the look and feel of your Coder deployment."
<AppearanceSettingsPageView
appearance={appearance}
isEntitled={isEntitled}
updateAppearance={updateAppearance}
/>

<Badges>
{isEntitled ? <EntitledBadge /> : <DisabledBadge />}
<EnterpriseBadge />
</Badges>

<Fieldset
title="Logo URL"
validation={
isEntitled
? "We recommend a transparent image with 3:1 aspect ratio."
: "This is an Enterprise only feature."
}
onSubmit={logoForm.handleSubmit}
button={!isEntitled && <Button disabled>Submit</Button>}
>
<p>
Specify a custom URL for your logo to be displayed in the top left
corner of the dashboard.
</p>
<TextField
{...logoFieldHelpers("logo_url")}
defaultValue={appearance.logo_url}
fullWidth
placeholder="Leave empty to display the Coder logo."
disabled={!isEntitled}
InputProps={{
endAdornment: (
<InputAdornment position="end" className={styles.logoAdornment}>
<img
alt=""
src={logoForm.values.logo_url}
// This prevent browser to display the ugly error icon if the
// image path is wrong or user didn't finish typing the url
onError={(e) => (e.currentTarget.style.display = "none")}
onLoad={(e) => (e.currentTarget.style.display = "inline")}
/>
</InputAdornment>
),
}}
/>
</Fieldset>

<Fieldset
title="Service Banner"
onSubmit={serviceBannerForm.handleSubmit}
button={
!isEntitled && (
<Button
onClick={() => {
updateAppearance(
{
service_banner: {
message:
"👋 **This** is a service banner. The banner's color and text are editable.",
background_color: "#004852",
enabled: true,
},
},
true,
)
}}
>
{t("showPreviewLabel")}
</Button>
)
}
validation={
!isEntitled && (
<p>
Your license does not include Service Banners.{" "}
<a href="mailto:[email protected]">Contact sales</a> to learn more.
</p>
)
}
>
<p>Configure a banner that displays a message to all users.</p>

{isEntitled && (
<Stack>
<FormControlLabel
control={
<Switch
color="primary"
checked={serviceBannerForm.values.enabled}
onChange={async () => {
const newState = !serviceBannerForm.values.enabled
const newBanner = {
...serviceBannerForm.values,
enabled: newState,
}
updateAppearance(
{
service_banner: newBanner,
},
false,
)
await serviceBannerForm.setFieldValue("enabled", newState)
}}
/>
}
label="Enabled"
/>
<Stack spacing={0}>
<TextField
{...serviceBannerFieldHelpers("message")}
fullWidth
label="Message"
variant="outlined"
multiline
/>
<FormHelperText>{t("messageHelperText")}</FormHelperText>
</Stack>

<Stack spacing={0}>
<h3>{"Background Color"}</h3>
<BlockPicker
color={backgroundColor}
onChange={async (color) => {
setBackgroundColor(color.hex)
await serviceBannerForm.setFieldValue(
"background_color",
color.hex,
)
updateAppearance(
{
service_banner: {
...serviceBannerForm.values,
background_color: color.hex,
},
},
true,
)
}}
triangle="hide"
colors={["#004852", "#D65D0F", "#4CD473", "#D94A5D", "#5A00CF"]}
styles={{
default: {
input: {
color: "white",
backgroundColor: theme.palette.background.default,
},
body: {
backgroundColor: "black",
color: "white",
},
card: {
backgroundColor: "black",
},
},
}}
/>
</Stack>
</Stack>
)}
</Fieldset>
</>
)
}

const useStyles = makeStyles((theme) => ({
form: {
maxWidth: "500px",
},
logoAdornment: {
width: theme.spacing(3),
height: theme.spacing(3),

"& img": {
maxWidth: "100%",
},
},
}))

export default AppearanceSettingsPage
Loading