カスタムエレメントVer.1からVer.2への具体的な移行手順書

カスタムエレメントVer.1からVer.2への具体的な移行手順書

Q. カスタムエレメントVer1からVer2への具体的な移行手順を教えてください。

A.以下が具体的な手順となります。

概要

カスタムエレメントVer1からVer2への、安全で具体的な移行手順書を記載します。


前提

既にカスタムエレメントVer1を使ってサイト内検索を提供しているお客様が対象となります。

本番環境とは別に、ステージングなどで動作確認する環境が必要です。


詳細
1.ステージング環境にて強制的にVer2を適用

最初に、ステージング環境にて強制的にカスタムエレメントVer2 を読み込ませるようにします。

検索窓画面と検索結果画面のページ内、以下2箇所を修正します。


【1箇所目】次のlinkタグを削除

<link href="https://ce.mf.marsflag.com/latest/css/mf-search.css" rel="stylesheet" type="text/css" media="all" charset="UTF-8">


【2箇所目】次のscriptタグを変更

変更前

<script src="https://ce.mf.marsflag.com/latest/js/mf-search.js" charset="UTF-8"></script>

変更後

<script
src="https://ce.mf.marsflag.com/v2/js/mf-search.js"
async
type="module"
></script>

※ /v2/ というパスを指定することで、強制的に Ver2を読み込ませることができます。



2.ステージング画面の確認と調整

1.を適用した後、検索窓画面と検索結果画面を確認し、必要であればページを修正して調整します。


動作や画面レイアウトを調整する際には、以下のドキュメントを参照してください。


3.本番への反映

2.の作業後、そのままステージングの内容を本番へ反映します。


4.管理画面より、Ver1 から Ver2への切り替えを行います。


5.ステージング環境の強制Ver2適用を解除

1.にて指定していた scriptタグを、以下のように通常状態へ戻します。
現在

<script
src="https://ce.mf.marsflag.com/v2/js/mf-search.js"
async
type="module"
></script>

修正後

<script src="https://ce.mf.marsflag.com/latest/js/mf-search.js" charset="UTF-8"></script>

※ /v2/ を /latest/ というパスに戻すことで、強制的な Ver2読み込みを解除します。


6.本番への反映

5.の作業後、そのままステージングの内容を本番へ反映します。


以上





    • Related Articles

    • カスタムエレメントVer.1 サポート終了後の対応につきまして

      MARS FINDER(3.0)のカスタムエレメントVer.1は、2025年10月末日をもってサポート終了となります。 これに伴い、同日以降は、新規作成したアプリケーションにおいてカスタムエレメントVer.1でのサービス新規作成ができなくなりますのでご注意ください。 サービス提供終了時期(EOL)は未定となっております。 サポート終了に伴う弊社の対応は、以下の通りとなります。 【カスタムエレメントVer.1のサポート終了後も継続対応となるもの】 サービス障害への問い合わせおよび対応 ...
    • カスタムエレメントVer.1とVer.2の違いを教えてください

      Q. カスタムエレメントVer.1とVer.2の違いを教えてください。 A.カスタムエレメントVer.2には、以下の機能が新たに追加されております。 より使いやすく進化したカスタムエレメントVer.2を是非ご利用ください。 AIによる回答表示機能 リアルタイム検索結果表示 Webアクセシビリティのガイドライン(「WCAG 2.0」基準及び「JIS X 8341-3:2016」)に準拠 管理画面上でのガイド付きセットアップとスタイリングツールで初心者も簡単にカスタマイズ ...
    • カスタムエレメントVer.2のWebサイト導入に際してのガイドライン

      MARS FINDER3.0において、カスタムエレメントVer.2をお客様のWebサイトへ導入される際には、以下の項目をご留意ください。 <mf-search-box>や<mf-search-results>等のカスタムエレメントが展開された後のDOM要素への、イベント追加は避けてください。 既にカスタムエレメントVer.1を導入済みのお客様に関しましては、本ガイドラインに準拠頂いていれば、大きな問題を生じさせずにVer.2への切り替えが可能です。 ...
    • 2025.01.09 [MARS FINDER 3.0] 機能改善のお知らせ

      以下の項目におきまして、機能改善を行いました。 MARS FINDER 3.0  ・カスタムエレメント Ver.1において、lang属性の動作を改善しました。  ・カスタムエレメント Ver.1において、search-on-load属性の動作を改善しました。
    • 2024.12.10 [MARS FINDER 3.0] 機能改善のお知らせ

      以下の項目におきまして、機能改善を行いました。 MARS FINDER 3.0  ・カスタムエレメント Ver.2において、use-links属性とoptions-hidden属性を同時に利用できるようになりました。  ・カスタムエレメント Ver.2において、スニペット中にHTMLタグが表示される場合がある件について、修正を行いました。  ・カスタムエレメント Ver.2において、Ver.1との互換性のため、results-page-urlと同様にserp-urlも使えるように修正しました。 ...