Typesetter Class

Palt Typesetting では、Typesetter クラスを使用して HTML 文字列に組版を適用します。
ライブラリの機能はオプションを通じてカスタマイズできます。

サンプルコード

/**
 * options: TypesettingOptions
 * オプションの設定
 */
const options = {
  // 単語や助詞など、単語区切りでの改行を行います。
  useWordBreak: true,

  // 英数を `.typesetting-latin` でラップします。
  wrapLatin: true,

  // 特例文字 `char` を `.typesetting-char-[label]` でラップします。
  wrapChars: [
    {
      char: 'あ',
      label: 'hira-a',
      // output: <span class="typesetting-char-hira-a">あ</span>
    },
    {
      char: '」',
      // output: <span class="typesetting-char-」">」</span>
      // label が未指定の場合は、char の値がそのまま label として使用されます。
    },
    {
      char: ['(', ')'],
      label: 'parenthesis',
      // output: <span class="typesetting-char-parenthesis">（）</span>
      // 配列で複数の文字をまとめて指定できます。
      // 配列の長さが2以上の場合は label の指定が必須です。
    },
  ],

  // 罫線などの分離禁則文字を `.typesetting-no-breaks` でラップし、文字間を 0 に設定します。
  noSpaceBetweenNoBreaks: true,

  // 四分アキスペースを自動で挿入します。
  insertThinSpaces: true,

  // 四分アキスペースの幅を設定します。
  thinSpaceWidth: '0.2em',

  // 特定の文字間のカーニングルールを設定します。
  kerningRules: [
    {
      between: ['し', 'ま'],
      value: '60',
    },
    {
      between: ['す', '。'],
      value: '-80',
    },
  ],
}

/**
 * Typesetter(options?: TypesettingOptions)
 * インスタンスの作成
 */
const typesetter = new Typesetter(options)

/**
 * renderToSelector(selector: string): void
 * セレクターにマッチする要素に対して組版を適用
 */
typesetter.renderToSelector('div')
typesetter.renderToSelector('.my-class')
typesetter.renderToSelector('#my-id')

/**
 * renderToElements(elements: string): void
 * HTML 文字列に組版を適用
 */
const elements = document.querySelectorAll('.my-class')
typesetter.renderToElements(elements)

/**
 * render(srcHtml: string): string
 * 組版を適用した HTML 文字列の取得
 */
const srcHtml = '「日本語」とEnglish'
console.log('output: ' + typesetter.render(srcHtml))
// output: <span class="typeset typesetting-wrapper typesetting-word-break">「日本語<span class="typesetting-char-」">」</span><span class="typesetting-thin-space" style="letter-spacing: 0.2em;" data-content=" "></span>と<span class="typesetting-thin-space" style="letter-spacing: 0.2em;" data-content=" "></span><span class="typesetting-latin">English </span></span>

コンストラクタ

メソッド

root には Document、Element、DocumentFragment を指定できます。省略時は実行時のグローバル document を使用し、DOMがない場合や null を指定した場合は何もしません。

オプション

生成される CSS クラス

for Typescript

TypeScript の型定義を提供しています。完全な型定義はこちらをご参照ください。

サンプルコード

import Typesetter from 'palt-typesetting'
import type { TypesettingOptions, KerningRule, WrapChar } from 'palt-typesetting/types'
import 'palt-typesetting/dist/typesetter.css'

const chars: WrapChar[] = [
  {
    char: 'あ',
    label: 'hira-a',
  },
  {
    char: ['(', ')'],
    label: 'parenthesis',
  },
]

const kerning: KerningRule[] = [
  {
    between: ['し', 'ま'],
    value: '60',
  },
]

const options: TypesettingOptions = {
  thinSpaceWidth: '0.25em',
  kerningRules: kerning,
  wrapChars: chars,
}

const typeset = new Typesetter(options)
typesetter.renderToSelector('.my-class')

for Frameworks

モダンな JavaScript フレームワーク用のサンプル集です。

Typesetting コンポーネントの作成

components/Typesetting.jsx

'use client'

import React, { useEffect, useState } from 'react'
import Typesetter from 'palt-typesetting'
import 'palt-typesetting/dist/typesetter.css'

import './Typesetting.css'

const Typesetting = ({ content }) => {
  const [renderedHtml, setRenderedHtml] = useState('')

  useEffect(() => {
    const typesetter = new Typesetter()
    setRenderedHtml(typesetter.render(content))
  }, [content])

  return <span dangerouslySetInnerHTML={{ __html: renderedHtml }} />
}

export default Typesetting

components/Typesetting.css

/* 共通のスタイル */
.typesetting-wrapper {
  font-feature-settings: 'palt';
  letter-spacing: 0.1em;
}

/* 英数のスタイル */
.typesetting-latin {
  font-size: 105%;
  letter-spacing: 0.05em;
}

Typesetting コンポーネントの作成

components/Typesetting.astro

---
import Typesetter from 'palt-typesetting'
import 'palt-typesetting/dist/typesetter.css'

const { content } = Astro.props
const slot = await Astro.slots.render('default')
const srcHtml = content || slot || ''

const typesetter = new Typesetter();
---

<Fragment set:html={typesetter.render(srcHtml)} />

<style is:global>
  /* 共通のスタイル */
  .typesetting-wrapper {
    font-feature-settings: 'palt';
    letter-spacing: 0.1em;
  }

  /* 英数のスタイル */
  .typesetting-latin {
    font-size: 105%;
    letter-spacing: 0.05em;
  }
</style>

Typesetting コンポーネントの読み込み

pages/index.astro

---
import Typeset from '../components/Typesetting.astro'
---

<div>
  <!-- props を使った書き方 -->
  <Typesetting content="「日本語」とEnglish、晴れ・28度。" />

  <!-- slot を使った書き方 -->
  <Typesetting>
    <a href="/work">作品ページ</a>
  </Typesetting>
</div>

<style>
 p {
  font-size: 1.8rem;
 }
</style>

Notes

環境要件

Palt Typesetting ライブラリは、テキストを言語固有のセグメントに分割する Intl.Segmenter という機能に一部依存しています。そのため、以下の環境要件があります。

SSG など、サーバーサイドで実行する場合

• Node.js 16.0.0 以上

クライアントサイドで実行する場合

• Intl.Segmenter をサポートしているブラウザ
• Intl.Segmenter がない環境でも、ES2020 の構文に対応している必要があります（UMD バンドル bundle/typesetter.min.js と dist/ は ES2020 で出力しています）

クライアントサイドで実行する場合、この機能は一部のブラウザで利用できません。Palt Typesetting ライブラリは、Firefox などの Intl.Segmenter がサポートされていない環境¹ では、useWordBreak（単語区切りでの改行）と insertThinSpaces（四分アキの自動挿入）オプションがスキップされます。全てのモダンブラウザで同様の見え方を再現するには、サーバーサイドでの事前処理（Astro.js での SSG など）が必要となります。

Intl.Segmenter の対応状況については、Can I use... で確認できます。

Node.js と DOM

render(html) はDOMライブラリなしで利用できます。jsdomは必須依存に含まれません。 ブラウザでは、従来どおり renderToSelector(selector) がグローバルの document を検索します。 Node.jsなど document が存在しない環境では、このメソッドは何もしません。

サーバー側でセレクタを使う場合は、自分で用意した Document または検索対象の Element を第2引数に渡してください。 例えばjsdomを使う場合は、利用するプロジェクトで別途インストールします。

import { JSDOM } from 'jsdom'
import Typesetter from 'palt-typesetting'

const dom = new JSDOM('<p>日本語English</p>')
const typesetter = new Typesetter()
typesetter.renderToSelector('p', dom.window.document)
// renderToElements(element) も引き続き使用できます。

従来の内部モジュール dist/win.js / dist/win-browser.js は廃止しました。 これらを直接importしていた場合は、呼び出し元でDOMを用意する方法に移行してください。

注意事項

thinSpaceWidth は 0.2em、20%、calc(1em / 2)、var(--spacing, 0.2em) などを指定できます。使用できる文字はASCII英数字、スペース、および .%()+*,/_- です。CSSコメント、HTML属性や別のCSS宣言を挿入する文字を含む値、空文字は既定値の 0.2em に置き換えられます。

Palt Typesetting ライブラリは HTML 入力をサポートしていますが、入力された HTML をサニタイズする機能は含まれていません。 入力を信頼できない場合は、適切なサニタイザライブラリと共に使用することを強く推奨します。

改行判定

改行判定には、UAX #14（Unicode 15.0）に基づく内蔵の実装を使用しています。 本ライブラリは 2 文字の境界だけを判定するため、Line_Break クラスの区間表と組み合わせ表だけを持ち、実行時の依存はありません。 これは従来 linebreak にセグメント境界の 2 文字だけを渡していた挙動との互換を保つためのもので、文章全体に対する UAX #14 の完全な判定ではありません （例: 地域指示子の個数に依存する LB30a は考慮しません）。 区間表は npm run generate:line-break で、scripts/ucd/ に置いた Unicode の LineBreak.txt から生成します。 判定結果は、Unicode の LineBreak.txt の全コードポイントのクラスと、LineBreakTest.txt の 2 文字のテストケースに照らしてテストしています。 テストケースのうち、前後の文脈や East_Asian_Width に依存する規則（LB25, LB30, LB30b）による 18 件は、従来の挙動に合わせた既知の差異です。

Development

開発・テストには Node.js 22.13 以上の 22 系、24 系、または 26 系を使用してください。CI でもこれらのメジャーバージョンを検証します。

npm ci
npm test -- --run
npm run lint
npx tsc --noEmit
npm run build
npm ci --prefix demo
npm run build --prefix demo

Author

飯塚 大和 (Yamato Iizuka)