@k8ordo/ui

Prose

MarkdownやMDXから描いたHTMLに、本文の組版を戻すコンテナです。記事の本文を包みます。

インポート

ts
import { Prose } from '@k8ordo/ui';

使い方

ベースのスタイルは見出しとリスト、余白、強調をリセットします。Proseの中でだけ、本文の組版が戻ります。行間は広め(leading-loose)で、見出しは詰め組み(palt)です。日本語のemは傍点で示します。

はじめに

本文の中の強い強調と強調、リンク、inline code が、読みやすく並ぶ。

  • リセットで消えた黒丸が戻る
  • 番号付きのリストも同じ

引用は罫線と控えめな文字色で示す。

tsx
<article>
  <Prose>
    <MDXContent />
  </Prose>
</article>

コンポーネントの配置

組版が効くのは、クラスの無い素の要素だけです。コンポーネントはどれもクラスを持つので、自分の見た目のままです。前後の間隔だけが本文と同じになります。MDXで要素をコンポーネントに対応づければその見た目に、素のままなら本文の見た目になります。

A paragraph before the component.

情報
  • First note
  • Second note

A paragraph after it.

tsx
<Prose>
  <p>A paragraph before the component.</p>
  <Alert message={['First note', 'Second note']} tone="info" />
  <p>A paragraph after it.</p>
</Prose>

縦書き

.writing-vの中では、本の組み方にならって段落の頭を1字下げます。

縦書き

縦書きでは、段落の頭を一字下げて組む。

二つ目の段落も、同じく一字下げる。

tsx
<div className="writing-v">
  <Prose>
    <p>…</p>
  </Prose>
</div>

Props

children?
Type: ReactNode
Default: -
PropTypeDefault
children?ReactNode-

継承する属性(内部で固定するものを除く): HTMLAttributes<HTMLDivElement>

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。