Skip to content

feat: Add Section component #863

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
BrunoQuaresma merged 2 commits into from
Apr 5, 2022
Merged

feat: Add Section component #863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adf367a
feat: Add Section component
BrunoQuaresma Apr 4, 2022
6e29dd2
fix: add Section.Action example
BrunoQuaresma Apr 5, 2022
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
17 changes: 17 additions & 0 deletions site/src/components/Section/Action.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { makeStyles } from "@material-ui/core/styles"
import React from "react"

const useStyles = makeStyles((theme) => ({
root: {
marginTop: theme.spacing(3),
},
}))

/**
* SectionAction is a content box that call to actions should be placed
* within
*/
export const SectionAction: React.FC = ({ children }) => {
const styles = useStyles()
return <div className={styles.root}>{children}</div>
}
37 changes: 37 additions & 0 deletions site/src/components/Section/SectionView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import Button from "@material-ui/core/Button"
import TextField from "@material-ui/core/TextField"
import { Story } from "@storybook/react"
import React from "react"
import { Section, SectionProps } from "./"

export default {
title: "Page/Section",
component: Section,
argTypes: {
title: { type: "string" },
description: { type: "string" },
children: { control: { disable: true } },
},
}

const Template: Story<SectionProps> = (args: SectionProps) => <Section {...args} />

export const Example = Template.bind({})
Example.args = {
title: "User Settings",
description: "Add your personal info",
children: (
<>
<form style={{ display: "grid", gridAutoFlow: "row", gap: 12 }}>
<TextField label="Name" variant="filled" fullWidth />
<TextField label="Email" variant="filled" fullWidth />
</form>

<Section.Action>
<Button variant="contained" color="primary">
Submit
</Button>
</Section.Action>
</>
),
}
73 changes: 73 additions & 0 deletions site/src/components/Section/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
import { makeStyles } from "@material-ui/core/styles"
import { fade } from "@material-ui/core/styles/colorManipulator"
import Typography from "@material-ui/core/Typography"
import React from "react"
import { SectionAction } from "./Action"

type SectionLayout = "fixed" | "fluid"

export interface SectionProps {
title?: React.ReactNode | string
description?: React.ReactNode
toolbar?: React.ReactNode
alert?: React.ReactNode
layout?: SectionLayout
children?: React.ReactNode
}

type SectionFC = React.FC<SectionProps> & { Action: typeof SectionAction }

export const Section: SectionFC = ({ title, description, toolbar, alert, children, layout = "fixed" }) => {
const styles = useStyles({ layout })
return (
<div className={styles.root}>
<div className={styles.inner}>
{(title || description) && (
<div className={styles.header}>
<div>
{title && <Typography variant="h4">{title}</Typography>}
{description && typeof description === "string" && (
<Typography className={styles.description}>{description}</Typography>
)}
{description && typeof description !== "string" && (
<div className={styles.description}>{description}</div>
)}
Copy link
Contributor

@presleyp presleyp Apr 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well thought out!

</div>
{toolbar && <div>{toolbar}</div>}
</div>
)}
{alert && <div className={styles.alert}>{alert}</div>}
{children}
</div>
</div>
)
}

// Sub-components
Section.Action = SectionAction

const useStyles = makeStyles((theme) => ({
root: {
backgroundColor: theme.palette.background.paper,
boxShadow: `0px 18px 12px 6px ${fade(theme.palette.common.black, 0.02)}`,
marginBottom: theme.spacing(1),
padding: theme.spacing(6),
},
inner: ({ layout }: { layout: SectionLayout }) => ({
maxWidth: layout === "fluid" ? "100%" : 500,
}),
alert: {
marginBottom: theme.spacing(1),
},
header: {
marginBottom: theme.spacing(4),
display: "flex",
flexDirection: "row",
justifyContent: "space-between",
},
description: {
color: theme.palette.text.secondary,
fontSize: 16,
marginTop: theme.spacing(2),
},
}))