Redmineの画面で振られているclass属性について

Redmineでは、デザイン変更がしやすいように、class属性が適宜設定されています。これらのclass属性を利用することにより、テーマやプラグインによるデザイン変更が簡単になっています。

本ページでは、どのようなclass属性が付与されているかを説明します。なお、確認はRedmine 2.5.2 にて行っています。(Redmineでは、バージョンアップの際にclass名の変更なども行われることが多々ありますので、ご注意ください)

デザイン変更方法自体は、下記をご参照ください。

body要素に付与されるもの

body要素には、ページ全体を表す情報として、下記のようなclass名が付与されています。

class名内容
controller-{コントローラ名} Railsでのコントローラ名。アクション名との組わせによって画面の識別が可能。 controller-issues
action-{アクション名} Railsでのアクション名。コントローラ名との組わせによって画面の識別が可能。 action-index
project-{プロジェクト名} Redmine上のプロジェクトの識別子。チケットの表示のように、プロジェクト別にURLが変わらないようなものでも、このclass名を判定することにより、どのプロジェクトの情報なのか判定できる。 project-testpj

たとえば、test1プロジェクトのトップページでは、

<body class="project-test1 controller-projects action-show">

といったclass名が付与されることになります。

f:id:onozaty:20141007000826p:plain

 

チケット一覧の各行に付与されるもの

チケット一覧の各行には、チケットのステータスや優先度などに応じて、下記のようなclass名が付与されています。

class名内容
issue チケットであることを表す。 issue
tracker-{トラッカーID}

そのチケットのトラッカーIDが付与される。

トラッカーIDは、「管理」→「トラッカー」で各トラッカーのURLから識別可能。(trackes/{ID}といったURLになっている)

tracker-1
status-{ステータスID}

そのチケットのステータスIDが付与される。

ステータスIDは、「管理」→「チケットのステータス」で各ステータスのURLから識別可能。(ssue_statuses/{ID}といったURLになっている)
status-1
priority-{優先度ID}

そのチケットの優先度IDが付与される。

優先度ID(※優先度は単なる列挙項目であり、実際は列挙項目毎のIDとなっている)は、「管理」→「列挙項目」の「チケットの優先度」のURLから識別可能。(enumerations/{ID}といったURLになっている)

※Readmine2.1から使用されるIDが変わっている(以前は、優先度の並び順で数値が決まっていた)

priority-3
priority-{優先度種別}

そのチケットの優先度種別が付与される。

チケットの優先度としてデフォルト値が設定されているものが"default"、一番低いものが"lowest"、高いものが"highest"となり、それ以外は、high/low{2からの通番}となる。

下記は優先度の例とそれに対応するclass名。

・低い → priority-lowest

・低め → priority-low2

・通常(デフォルト) → priority-default

・高め → priority-high3

・急いで → priority-high2

・今すぐ → priority-highest

priority-lowest

priority-low2

priority-default

priority-high2

priority-highest

created-by-me 自分が作ったチケットの場合に付与。 created-by-me
assigned-to-me 自分が担当となっているチケットの場合に付与。 assigned-to-me
closed 終了状態のチケット。 closed
private プライベートのチケット。 private

上記のように、チケットの各種情報がclass名から判別できるため、カスタマイズが簡単です。

また、デフォルトで用意されているテーマの「Alternate」では、下記のようにステータスや優先度に応じて強調表示してくれます。

f:id:onozaty:20141013223953p:plain

 

とりあえず主要なものだけあげましたが、他にもいろいろclass/id属性が振られているので、ブラウザの開発ツール(Firebug、Developer Toolなど)などで確認してみると良いかと思います。

デザイン変更で、あなた好みのRedmineにしてみてください!