Prose
Installation
import { Prose } from "@o/pipeline/components/prose";
Usage
Default
Heading 1
Heading 2
Heading 3
Paragraph with bold, italic, underlined, and strikethrough text.
Paragraph with code, bold code, italic code, bold italic code, underline code, , and strikethrough codelinked code.
Paragraph with link, bold link, italic link, bold italic link, underline link, strikethrough link, followed by a horizontal rule.
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
Blockquote
import { Prose } from "@o/pipeline/components/prose";
export default function Example() {
return <Prose />;
}Comfortable
Heading 1
Heading 2
Heading 3
Paragraph with bold, italic, underlined, and strikethrough text.
Paragraph with code, bold code, italic code, bold italic code, underline code, , and strikethrough codelinked code.
Paragraph with link, bold link, italic link, bold italic link, underline link, strikethrough link, followed by a horizontal rule.
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
Blockquote
import { Prose } from "@o/pipeline/components/prose";
export default function Example() {
return <Prose />;
}“Unsupported” Elements
The following elements work with Prose, but aren’t styled according to our
branding guidelines — use with caution.
codepreh4dl,dt, andddfigure, andfigcaptionimgvideotable,thead,tr,th,td, andtbody
See OP-2192: Design for (or disable) additional elements within Prose for more details.
Sensible Max Width
By default, Prose, doesn’t impose any width constraints, but it does offer a max-width optimized for legibility.
<Prose maxWidth />
Heading 1
Heading 2
Heading 3
Paragraph with bold, italic, underlined, and strikethrough text.
Paragraph with code, bold code, italic code, bold italic code, underline code, , and strikethrough codelinked code.
Paragraph with link, bold link, italic link, bold italic link, underline link, strikethrough link, followed by a horizontal rule.
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
Blockquote
import { Prose } from "@o/pipeline/components/prose";
export default function Example() {
return <Prose />;
}Removing Default Color
By default, Prose sets opinionated defaults. This can be overridden where necessary.
<Prose color={false} className="text-cornflower" />
Heading 1
Heading 2
Heading 3
Paragraph with bold, italic, underlined, and strikethrough text.
Paragraph with code, bold code, italic code, bold italic code, underline code, , and strikethrough codelinked code.
Paragraph with link, bold link, italic link, bold italic link, underline link, strikethrough link, followed by a horizontal rule.
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
Blockquote
import { Prose } from "@o/pipeline/components/prose";
export default function Example() {
return <Prose />;
}Sandboxing
To isolate content from the outer Prose, you can use the unset prop (which uses @tailwindcss/typography’s not-prose class under-the-hood)
Warning
Note that you can’t nest new <Prose /> instances within a <Prose unset /> block at this time.
See the @tailwindcss/typography documentation for further reading
Heading 1
Heading 2
Heading 3
Paragraph with bold, italic, underlined, and strikethrough text.
Paragraph with code, bold code, italic code, bold italic code, underline code, , and strikethrough codelinked code.
Paragraph with link, bold link, italic link, bold italic link, underline link, strikethrough link, followed by a horizontal rule.
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
Blockquote
import { Prose } from "@o/pipeline/components/prose";
export default function Example() {
return <Prose />;
}