0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

SlickGridでoddクラスが競合して表示崩れした話

0
Posted at

はじめに

この記事では、SlickGrid が内部で付与している odd / even クラスと、自前の jQuery 処理で使っていた .odd セレクタが競合した話を整理します。

一見すると小さな話ですが、古めの UI ライブラリと jQuery を組み合わせている画面ではかなり起きやすい問題です。

特に危ないのは次のようなケースです。

  • 短く一般的なクラス名を自前で付ける
  • jQuery で .odd のような広いセレクタを書く
  • ライブラリが生成する DOM をあまり確認せずに処理を書く

今回の主題はシンプルです。

  • 原因は SlickGrid の内部クラスと自前クラスの競合だった
  • odd や even のような汎用名は衝突しやすい
  • UI ライブラリを使う画面では、クラス名はかなり慎重に付けた方がよい

起きたこと

自分のコード側で .odd を対象にした jQuery 処理を書いていたところ、意図した要素だけでなく SlickGrid の行にも影響してしまいました。

例えば、次のようなコードです。

$(".odd").addClass("highlight");

あるいは、

$(".odd").css("background-color", "#ffeeee");

この種のコードは、自前で付けた .odd クラスだけに効くつもりで書きがちです。
しかし実際には、SlickGrid 側も行の偶奇判定に odd / even を使っていました。

その結果、SlickGrid の奇数行にまでスタイルや処理がかかり、表示崩れや意図しない見た目の変化が起きました。

原因

原因は、SlickGrid が内部で行に対して odd / even クラスを自動付与していたことです。

該当箇所は次のような処理です。

function appendRowHtml(stringArray, row, range, dataLength) {
  var d = getDataItem(row);
  var dataLoading = row < dataLength && !d;
  var rowCss = "slick-row" +
      (dataLoading ? " loading" : "") +
      (row === activeRow ? " active" : "") +
      (row % 2 == 1 ? " odd" : " even");

  if (!d) {
    rowCss += " " + options.addNewRowCssClass;
  }

  var metadata = data.getItemMetadata && data.getItemMetadata(row);

  if (metadata && metadata.cssClasses) {
    rowCss += " " + metadata.cssClasses;
  }

  stringArray.push("<div class='ui-widget-content " + rowCss + "' style='top:" + getRowTop(row) + "px'>");

  var colspan, m;
  for (var i = 0, ii = columns.length; i < ii; i++) {
    m = columns[i];
    colspan = 1;
    if (metadata && metadata.columns) {
      var columnData = metadata.columns[m.id] || metadata.columns[i];
      colspan = (columnData && columnData.colspan) || 1;
      if (colspan === "*") {
        colspan = ii - i;
      }
    }

    if (columnPosRight[Math.min(ii - 1, i + colspan - 1)] > range.leftPx) {
      if (columnPosLeft[i] > range.rightPx) {
        break;
      }

      appendCellHtml(stringArray, row, i, colspan, d);
    }

    if (colspan > 1) {
      i += (colspan - 1);
    }
  }

  stringArray.push("</div>");
}

重要なのはこの1行です。

(row % 2 == 1 ? " odd" : " even");

つまり SlickGrid は、奇数行なら odd、偶数行なら even を付けます。

この状態でアプリ側が .odd を広く拾うと、自前の要素だけでなく SlickGrid の行まで巻き込まれます。

なぜ危ないのか

odd や even のような名前は、短くて分かりやすい反面、かなり衝突しやすいです。

特に次の条件が揃うと危険です。

  • UI ライブラリが DOM を自動生成する
  • ライブラリ内部の class 名を把握していない
  • jQuery でグローバルに近いセレクタを書く

CSS クラス名はスコープが弱いので、短く一般的な名前ほど他とぶつかりやすくなります。

これは SlickGrid に限りません。
古めの jQuery プラグイン、Bootstrap 系の既存 CSS、業務画面に長く積み重なった独自スタイルでも同じことが起きます。

問題が起きやすい書き方

次のような書き方は危険です。

$(".odd").addClass("selected");
.odd {
  background-color: #f5f5f5;
}

この書き方だと、「自分が付けた .odd」と「ライブラリが付けた .odd」を区別できません。

jQuery のセレクタや CSS は、こちらの意図とは無関係に同じ class 名へ一括で効きます。

対策

対策は、短く一般的な class 名を避けることです。

実務では次の方針が安全です。

  • 自前クラスにはプレフィックスを付ける
  • .odd のような広すぎるセレクタを避ける
  • 親要素で対象範囲を絞る
  • ライブラリが生成する DOM と class 名を先に確認する

1. 自前クラスにプレフィックスを付ける

例えば次のようにします。

<div class="my-feature-odd"></div>
$(".my-feature-odd").addClass("highlight");

odd 単体より、用途が分かる名前のほうが安全です。

2. セレクタの範囲を親要素で絞る

どうしても既存クラスを使うなら、対象範囲を限定します。

$("#my-area .odd").addClass("highlight");

これでも完全に安全とは言えませんが、少なくとも画面全体の .odd を拾うよりは事故が減ります。

3. ライブラリ側の DOM を先に見る

ライブラリを使っている画面では、HTML を自分で全部書いていないことが多いです。

そのため、何かクラス名を付けたり拾ったりする前に、開発者ツールで次を見た方が安全です。

  • 実際にどんな DOM が生成されているか
  • どんな class 名が既に使われているか
  • 自分の処理対象が本当に限定されているか

修正例

例えば、元のコードが次のようなものだったとします。

$(".odd").css("font-weight", "bold");

これを次のように変えるだけでもかなり違います。

$(".my-summary-odd").css("font-weight", "bold");

あるいは、既存クラスを使い続ける事情があるなら、親要素で絞ります。

$("#summary-panel .odd").css("font-weight", "bold");

前者のほうが本質的な対策です。
後者は応急処置としては有効ですが、将来的な保守ではプレフィックス付きの専用クラスへ寄せた方が安全です。

学び

今回の件で大事だったのは、SlickGrid が悪いという話ではないことです。

問題は、ライブラリ内部でも使われそうな汎用名を、自分のコードでも無警戒に使っていたことでした。

短い class 名は書きやすいですが、長く運用される画面ほど危険です。
特に jQuery と古めの UI ライブラリが混ざる画面では、命名の衝突がそのまま表示崩れにつながります。

まとめ

SlickGrid では内部で odd / even クラスを行に付与しています。

そのため、アプリ側で .odd のような汎用クラス名や広いセレクタを使うと、SlickGrid の行にまで影響して競合が起きます。

今回のような問題を避けるには、次の方針が有効です。

  1. 汎用的すぎる class 名を避ける
  2. 自前クラスにはプレフィックスを付ける
  3. jQuery セレクタの対象範囲を絞る
  4. ライブラリが生成する DOM と class 名を先に確認する

古いフロントエンド資産では、JavaScript のロジックより先に、class 名の衝突を疑った方が早いことがあります。

SlickGrid の別のトラブルシュートとして、SlickGridの列幅変更が動かない問題を、AIと原因切り分けで解決した記録 でも調査の進め方を整理しています。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?