Skip to content

pantoken / renderers/web-components/src / buildRegisterContext

関数: buildRegisterContext()

buildRegisterContext(options, target, resolveIconSvg): RegisterContext

アルファ

共有の RegisterContext を構築し、各要素の define に対して register() スタイルの呼び出しスレッドを接続します。アイコンリゾルバは注入可能です:register() は常に実際の、@pantoken/icons バックの iconSvg(既存の呼び出し元に対する既定の振る舞いを変更しない)を渡します。一方で、要素ごとの CDN ビルドは決して呼ばれない要素に対して noopIconSvg を渡します — @pantoken/icons/@pantoken/tokens は数メガバイト級の依存であり、Rollup は iife/umd 出力をコード分割できないため、バンドルのエントリから静的に到達可能なものは、その特定の要素のコードパスが実行されるかどうかに関わらずバンドル全体に含まれてしまいます。このモジュールにはまさにその理由でトップレベルの副作用はありません — インポートしても(../index.ts をインポートするときのようにインポート時にすべてを自動登録するのとは異なり)呼び出し元が渡さない限り iconSvg には到達しません。

パラメーター

options

RegisterContextOptions

register() のオプションと同じ形状で、only を除いたものです。

target

ElementRegistry

定義先のレジストリ。

resolveIconSvg

(name) => string

ctx.iconSvg に配線されるリゾルバ — 実際のアイコンには iconSvg を渡すか、呼び出し元の要素群が明らかにアイコンをレンダリングしない場合は noopIconSvg を渡してください(詳細は ICON_ELEMENTS./elements-meta.ts の中で参照)。

戻り値

RegisterContext