Skip to content

refactor: Add <CodeBlock /> component #168

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 9 commits into from
Feb 7, 2022
Merged
Show file tree
Hide file tree
Changes from 7 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
24 changes: 24 additions & 0 deletions site/components/CodeBlock/index.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { Story } from "@storybook/react"
import React from "react"
import { CodeBlock, CodeBlockProps } from "./index"

const sampleLines = `Successfully assigned coder/image-jcws7 to cluster-1
Container image "gcr.io/coder-dogfood/master/coder-dev-ubuntu@sha256" already present on machine
Created container user
Started container user
Using user 'coder' with shell '/bin/bash'`.split("\n")

export default {
title: "CodeBlock",
component: CodeBlockProps,
argTypes: {
lines: { control: "object", defaultValue: sampleLines },
},
}

const Template: Story<CodeBlockProps> = (args: CodeBlockProps) => <CodeBlock {...args} />

export const Example = Template.bind({})
Example.args = {
lines: sampleLines,
}
16 changes: 16 additions & 0 deletions site/components/CodeBlock/index.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { screen } from "@testing-library/react"
import { render } from "../../test_helpers"
import React from "react"
import { CodeBlock } from "./index"

describe("CodeBlock", () => {
it("renders lines)", async () => {
// When
render(<CodeBlock lines={["line1", "line2"]} />)

// Then
// Both lines should be rendered
await screen.findByText("line1")
await screen.findByText("line2")
})
})
38 changes: 38 additions & 0 deletions site/components/CodeBlock/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { makeStyles } from "@material-ui/core/styles"
import React from "react"

interface CodeBlockProps {
lines: string[]
}

export const CodeBlock: React.FC<CodeBlockProps> = ({ lines }) => {
const styles = useStyles()

return (
<div className={styles.root}>
{lines.map((line, idx) => (
<div className={styles.line} key={idx}>
{line}
</div>
))}
</div>
)
}
const MONOSPACE_FONT_FAMILY =
"'Fira Code', 'Lucida Console', 'Lucida Sans Typewriter', 'Liberation Mono', 'Monaco', 'Courier New', Courier, monospace"

const useStyles = makeStyles((theme) => ({
root: {
minHeight: 156,
background: theme.palette.background.default,
color: theme.palette.codeBlock.contrastText,
fontFamily: MONOSPACE_FONT_FAMILY,
fontSize: 13,
wordBreak: "break-all",
padding: theme.spacing(2),
borderRadius: theme.shape.borderRadius,
},
line: {
whiteSpace: "pre-wrap",
},
}))
32 changes: 30 additions & 2 deletions site/theme/palettes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ import { Palette } from "@material-ui/core/styles/createPalette"
*/
declare module "@material-ui/core/styles/createPalette" {
interface Palette {
codeBlock: {
// Text color for codeblocks
contrastText: string
// Background color for codeblocks
main: string
}
navbar: {
main: string
}
Expand All @@ -17,6 +23,10 @@ declare module "@material-ui/core/styles/createPalette" {
}

interface PaletteOptions {
codeBlock: {
contrastText: string
main: string
}
navbar: {
main: string
}
Expand All @@ -32,7 +42,18 @@ declare module "@material-ui/core/styles/createPalette" {
*/
export type CustomPalette = Pick<
Palette,
"action" | "background" | "divider" | "error" | "hero" | "info" | "navbar" | "primary" | "secondary" | "text" | "type"
| "action"
| "background"
| "codeBlock"
| "divider"
| "error"
| "hero"
| "info"
| "navbar"
| "primary"
| "secondary"
| "text"
| "type"
>

/**
Expand All @@ -47,7 +68,10 @@ export const lightPalette: CustomPalette = {
default: "#F3F3F3",
paper: "#FFF",
},

codeBlock: {
main: "#F3F3F3",
contrastText: "rgba(0, 0, 0, 0.9)",
},
primary: {
main: "#519A54",
light: "#A2E0A5",
Expand Down Expand Up @@ -108,6 +132,10 @@ export const darkPalette: CustomPalette = {
secondary: lightPalette.secondary,
info: lightPalette.info,
error: lightPalette.error,
codeBlock: {
main: "rgb(24, 26, 27)",
contrastText: "rgba(255, 255, 255, 0.8)",
},
hero: {
main: "#141414",
button: "#333333",
Expand Down