最新のhtml+javascript+cssにおける「真のカスタムエレメント」を考える

# やりたかったこと
ここ最近，`vscode`上で`markdown`をひたすら使い潰すためだけに色々とやってきているのだが（以下はこれまでの記事），

https://soluna-eureka.hatenablog.com/entry/2021/11/15/130821

https://soluna-eureka.hatenablog.com/entry/2021/11/15/164830

https://soluna-eureka.hatenablog.com/entry/2021/11/30/044748

これまでの研究により`markdown pdf`の`extension.js`を書き換えることで任意の`.html`・`.js`・`.css`ファイルをプラグインとして利用できる環境を作れてしまうことが判明し，これに`katex`を混ぜることで概ね万能な数式の表示すら可能となった．

しかし大元の発端は「`latex`が面倒だから`markdown`を使おう」というものであり，つまるところ`latex`にある機能が`katex`さらにはそれが対応できる`markdown`には搭載し得ないもので，これは下位互換にすぎない不完全な環境であったのだ．<br>
そこで私が考えついたのが，「`latex`に備わる組版用の各種コマンドを`html`の機能で代替できないか？」というものである．



## 目標
完全に独立した名前を持ち，余計な指定をする必要がなく，かつ`id`と`style`が自在に設定できる「真のカスタムエレメント」を実現する．これにより`latex`コマンドに対応するカスタムエレメントを自由に作成，柔軟な組版を`markdown`で実現する．



## 方針
かつては`document.registerElement`で好き放題にできていたらしく，その手法を扱った記事がいまだに検索にヒットするが，

https://developer.mozilla.org/en-US/docs/Web/API/Document/registerElement

現在では全ブラウザ非対応の憂き目に合っている（リンク先は英語ページのみ）．ゆえに代替である`CustomElementRegistry`

https://developer.mozilla.org/ja/docs/Web/API/CustomElementRegistry

インターフェースが持つ`customElements.define`（あっちは`Element`なのにこっちは`Elements`なの，控えめに言って最悪）

https://developer.mozilla.org/ja/docs/Web/API/CustomElementRegistry/define

を使用せざるを得ないが，現在では数多くの記事においてこのページが示す「自律型」「拡張型」の2種類のみを扱っている．

しかし前者はタグの間の文字を扱えない（DOMパースがシカトされる）・後者は`is=''`の指定が必要（DOMパースしてくれる）ため，私の要求には満たない．他方で`whatwg`（`html`系開発コミュニティ）による`custom elements`のリファレンスでは，

https://triple-underscore.github.io/HTML-custom-ja.html#custom-elements-upgrades-examples


>カスタム要素定義を登録するのは、 それに関連する要素が初期時に — 構文解析器などにより — 作成された後の方が，好ましいこともある。 昇格は、 そのような用法を可能化して，［ カスタム要素の内容を漸進的に増強する ］ことを許容する。

という内容もあり，つまりは「名前に`-`が入っているエレメントはカスタム要素として解析が後回しにされる」程度には動作の許容がある．更には「任意の`html`要素を指す」`HTMLElement`（任意？あっ…）が現在でも全てのブラウザで実装されている

https://developer.mozilla.org/ja/docs/Web/API/HTMLElement

ため，この2つを足がかりにして攻略していった結果，なぜだか無事に攻略に成功した．


### 困難
カスタムエレメントなだけあって処理順の設定が難しく，上記2点の仕様が変わらなくても他の関数の仕様が変わるだけで死ぬ可能性は否定できない．これはあくまで2021年12月現在の情報であることはお許しいただきたい（未来のことは知らない）．




# やり方
まずは上の3つの記事を読むことこそお勧めする（プラグイン管理が格段に楽になるので）が，実際は読まなくても大丈夫だ．



## 原理
以下では`<div></div>`由来のボックスとしての`<d-box></d-box>`を作成する．

```template.js
class DBox2 extends HTMLDivElement {
    constructor() {
        super();
        this.id = 'box';
    }
}

customElements.define('d-box2', DBox2, { extends: 'div' });


class DBox extends HTMLElement {
    constructor() {
        super();
        let wrapper = document.createElement('div');
        wrapper.id = 'box';
        let content = this.innerHTML;
        console.log(content);
        this.innerHTML = '';
        wrapper.insertAdjacentHTML("afterbegin", content);
        this.insertAdjacentElement("beforeend", wrapper);
    }
}

document.addEventListener("DOMContentLoaded", function() {
    customElements.define('d-box', DBox);
});
```

```template.css
body {
    color: #222;
    background-color: #fff;
}

#box {
    color: #444;
    border: 5px solid #666;
    border-radius: 10px;
    padding: 5px;
    margin: 5px;
}
```

```test.md
# これはなんですの？

## `custom element`ですわ！

マニュアル通りの手法では
<div is='d-box2'>
sasa
</div>

わたくしが極めた手法では
<d-box>
二重動作もOKですわ！
<d-box>
$$
    \begin{align}
    e=mc^2 \\\\
    e^{i\pi}+1=0
    \end{align}
$$
</d-box>
</d-box>
```

↓

![スクリーンショット 2021-12-10 3.26.47.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/540440/b3f98b57-3099-3ade-38fc-376e2246420b.png)



### 何をやったか
なんの情報も持たない`<d-box></d-box>`の中身を丸ごと文字列で抜き取り`<div id='box'></div>`を埋め込んで更にそこに元の文字列を入れただけ，要するに作業としては大したことはやっていない…が，**処理同期手法の試行錯誤が面倒だった**ことに加え，そもそも「そういうやり方しかない」という結論に至るまでに半日ほど要してしまったことがあり，少し辛かった．<br>

ちなみに`<div is='d-box2'></div>`はよく紹介されているやり方である，どちらも同じ結果を得ている以上これは成功だろう．



## クラス化
`super`のリファレンスに目を通した時に「この処理はチェーン化できるのでは」と気づいたので，実際に実装に成功してみた．


結果は省略するが以下にクラス処理に関する記述を載せる，例として`AncestorOfAll`からフォールバックし3段組を実現する．

```template.js
class AncestorOfAll extends HTMLElement {
    constructor(element, purpose) {
        super();
        let wrapper = document.createElement(element);
        wrapper.id = purpose;
        let content = this.innerHTML;
        console.log(content);
        this.innerHTML = '';
        wrapper.insertAdjacentHTML("afterbegin", content);
        this.insertAdjacentElement("beforeend", wrapper);
    }
}

class DCol3 extends AncestorOfAll {
    constructor() {
        super('div', 'col3');
    }
}

document.addEventListener("DOMContentLoaded", function() {
    customElements.define('d-col3', DCol3);
});
```

```template.css
#col3 {
    column-count: 3;
    padding: 20px;
    margin: 10px;
}
```

要は`super()`で`super()`を呼び出しているに過ぎず，あとは先程と同じように`<d-col3></d-col3>`で呼び出せば良いだろう．




## 立つ鳥跡を濁さず
カスタムエレメントを使用した痕跡を全く残さないということも可能ではあり（自分でデバッグできなくなるが），これを活用すると`katex`の環境や関数をelement風に呼び出せるため非常に可読性が高まってとても良い．ただし環境と関数の定義の順番を間違えると動作しなくなったり，一部の無駄だと思える要素を省略すると動作しなくなったりするため，注意が必要である．

```template.js
// define your custom math func
// これを後にすると動かない
class AncestorOfMathFunc extends HTMLElement {
    constructor(purpose) {
        super();
        let mathHead = '\\begin{' + purpose + '}';
        let mathTale = '\\end{' + purpose + '}';
        this.insertAdjacentHTML('afterbegin', mathHead);
        this.insertAdjacentHTML('beforeend', mathTale);
        let content = this.innerHTML;
        this.insertAdjacentHTML('beforebegin', content)
        this.remove();
    }
}

class PMatrix extends AncestorOfMathFunc { //丸括弧の行列表記
    constructor() {
        super('pmatrix');
    }
}
document.addEventListener('DOMContentLoaded', function() {
    customElements.define('g-pmatrix', PMatrix); //<g-pmatrix></g-pmatrix>で呼び出し
});

class Cases extends AncestorOfMathFunc { //場合分け表記
    constructor() {
        super('cases');
    }
}
document.addEventListener('DOMContentLoaded', function() {
    customElements.define('g-cases', Cases); //<g-cases></g-cases>で呼び出し
});


// define your custom math mode
// これを先にすると動かない
class AncestorOfMathMode extends HTMLElement {
    constructor(element, purpose) {
        super();
        let breaking = document.createElement('br');
        let mathHead = '\\begin{' + purpose + '}';
        let mathTale = '\\end{' + purpose + '}';
        let mathWrapper = '$$';
        this.insertAdjacentHTML('afterbegin', mathHead);
        this.insertAdjacentHTML('afterbegin', mathWrapper);
        this.insertAdjacentHTML('beforeend', mathTale);
        this.insertAdjacentHTML('beforeend', mathWrapper);
        this.insertAdjacentElement('beforeend', breaking); //これを無効化すると動かない
        let wrapper = document.createElement(element);
        wrapper.id = purpose;
        let content = this.innerHTML;
        this.innerHTML = '';
        wrapper.insertAdjacentHTML('afterbegin', content);
        this.insertAdjacentElement('beforebegin', wrapper);
        this.remove();
    }
}

class DAlign extends AncestorOfMathMode { //align環境
    constructor() {
        super('div', 'align');
    }
}
document.addEventListener('DOMContentLoaded', function() {
    customElements.define('d-align', DAlign); //<d-align></d-align>で呼び出し
});

class DAlignN extends AncestorOfMathMode { //align*環境
    constructor() {
        super('div', 'align*');
    }
}
document.addEventListener('DOMContentLoaded', function() {
    customElements.define('d-alignn', DAlignN); //<d-alignN></d-alignN>で呼び出し
});
```

この環境定義の動作手順は

1. タグの中身の文字列を操作
1. 数式環境の呼び出しに対応
1. **`<div></div>`を生成**
1. `id`を設置し書式設定が可能な状態に
1. タグの中身をinnerHTMLと解釈
1. 生成した`<div></div>`にコピペ
1. 痕跡を消去

という流れで，関数定義の動作手順とは**`<div></div>`を生成するかどうか**に違いがある．<br>
かつ`document.addEventListener('DOMContentLoaded', function() {}`は，その定義順に実行される．<br>
そこで何かしら`katex`の解釈に不都合が事象が発生している…と考えられるだろう．




# 欠点
本文や数式の分量増えるほどに動作が遅くなる（DOMを操作する量が多くなるから），`markdown`プレビューが`katex`を含め機能しなくなる（vscode上の機能が解釈できないから）…等がある．正直`katex`のレンダリング速度に割と助けられている．




# 感想
恐らく初めて`javascript`のクラスのお勉強をしたし，処理の同期や非同期について考えた．`template.js`は`<head><\head>`に入っているし，恐らくどこに置いても正常に動作すると考えられる（一部のリファレンスは末尾設置を推奨しているけど）．
ただし念のために`katex`よりも前に読み込む設定にはした方が良い，レンダリングのどこかで不都合が起きるかもしれない．

今後より`latex`ライクな環境に近づけようなどと考えているが，もしこれに使い道があれば是非とも使ってもらえると嬉しい．