Skip to content

README.md

Latest commit

 

History

History
122 lines (92 loc) · 7.68 KB

README.md

File metadata and controls

122 lines (92 loc) · 7.68 KB

@styles/README

ここでは，このフォルダにあるCSSについて説明します．CSSを加筆する際は，まずこの説明を読んでから作成してください．

このファイルの説明は，CSSに関する基礎知識を前提としています．

@layoutsおよび@components/utilsとの棲み分けについて

@layoutsや@components/utilsにある.astroファイルには，そのコンポーネントだけに適用されるCSSを一緒に記述することができます．@stylesにあるべきCSSと@layoutsや@components/utilsにあるべきCSSの棲み分けは，以下のようになります．

  • @styles：以下の2種類のCSSを書きます．
    • グローバルに適用されるCSS：各ページのMarkdownの範囲に適用されるべきCSS
    • 多くのMarkdownで利用されるCSS：.boxやimg.mediumなどのユーティリティクラス
  • @layouts：ヘッダーやフッターなど，各ページのMarkdownの範囲外でのみ利用されるCSSを書きます．
  • @components/utils：各コンポーネントの中でのみ利用されるCSSを書きます．

components以下で定義されているユーティリティクラスについて

@styles/componentsにはユーティリティクラスが定義されています．これらのクラスはグローバルに適用されており，Markdown内で適用することができます．その際には，IALの記法（README参照）を利用するとクラスを適用する際にわざわざHTMLを書く必要がなく便利です．

.box系

記述ファイル：components/box.scss

リンク等の強調表示などを目的として，要素に囲みを付けるために利用するクラスです．

  • .box
    • 最も基本的な囲みです．文字色と同じ色の幅1pxの枠線が付加されるほか，ブロック要素として扱われます．
    • 利用例：@pages/utokyo_account/index.mdx
  • .box--important
  • .box--alert
    • .boxのスタイルに加えて，枠線の幅が2pxに，文字が太字に，文字色が$redになります．
    • 利用例：@pages/notice/20210403-utnet.md
  • strong.box, b.box
    • strong要素やb要素に.boxクラスを付与すると，枠線の幅が2pxに，文字が太字になります．
    • .boxを付与しているため，これらはブロック要素として扱われます．
    • 利用例：@pages/events/2022-slack/index.md

枠線と文字を太くする場合の実装

現在の実装では，strongとb以外の要素に対して「枠線幅2px」と「太字」のスタイルのみを適用するクラスはありません．そのため，文字サイズや文字色を変えずにこれらのスタイルを適用する目的で，本来であればdiv要素やp要素を用いるべきところで，strong要素やb要素に.boxクラスを付与するような実装が多くの箇所で行われています．

.cards

記述ファイル：components/card.scss

カード表示のためのクラスです．このクラスが付与された要素を直接の親にもつli要素またはa要素は，枠線や太字等のスタイルが適用されたブロック要素としてグリッド状に配置されます．

基本的にトップページでのみ用いられていますが，@pages/utokyo_vpn/index.mdなど複数のリンクをまとめて強調表示したい場合にも利用例があります．

  • .cards
  • .cards + h2
    • h2要素に対してこのクラスを付与すると，上方向にmarginが適用されます．

img系

記述ファイル：components/img.scss

画像のスタイルを設定するためのクラスです．

なお，以下のクラスを付与しない場合，img要素はデフォルトでブロック要素となり，横幅の上限が100%，縦幅の上限が40remとなります．

img要素に対するクラス

  • img.large, img.medium, img.small, img.extra-small
    • 画像の大きさを調節することができます．
      • .large：画像の横幅が必ず100%となります．
      • .medium：画像の横幅の上限が40remとなります．
      • .small：画像の横幅の上限が30rem，縦幅の上限が30remとなります．
      • .extra-small：画像の横幅の上限が15rem，縦幅の上限が15remとなります．
  • img.inline
    • img要素をインライン要素にします．
  • img.icon
    • img要素をインライン要素にし，画像の縦幅の上限を1.5emとします．加えて垂直方向の配置（vertical-align）がmiddleになります．
    • UIの説明などを目的として文中にアイコンの画像等を挿入する際に使用します．
  • img.center
    • 画像を中央揃えで配置します．
  • img.border
    • 画像に枠線が付加されます．また，.borderクラスの付いたimg要素が隣接する場合には，2番目以降の要素にmargin-topが設定されます．

img要素の親要素に対するクラス

  • figure.center
  • .gallery
    • 主にfigure要素に対して設定するクラスです．子要素のimg要素を横方向に並べて表示することができます．
    • 利用例：@pages/utokyo_vpn/index.md

ol, ul系

記述ファイル：components/lists.scss

箇条書きや番号付きリストに対してスタイルを設定するためのクラスです．

  • ul.gap, ol.gap
  • ol.bracket
    • 番号付きリストのフォーマットが[1], [2], [3], ... に変更されます．
    • 特別な理由がない限り使用は推奨されません．

MFA系

記述ファイル：components/mfa.scss

「UTokyo Account多要素認証の初期設定手順」のページにおいて番号付きリストに独自のフォーマットを適用するためのクラスです．

このクラスは実装の変更に伴い今後使用されなくなる予定で，現在では/en/utokyo_account/mfa/initial/でのみ利用されています．

.top__systems

記述ファイル：components/top.scss

  • .top__systems
    • 子要素を2段組で配置します．
    • @pages/index.mdx の「東京大学のシステム」セクションでのみ使用されています．

その他

記述ファイル：components/utils.scss

  • .alert
    • 文字色が$redになります．
  • .center
    • 文字の配置を中央揃えにします．
  • .iframe-container
    • iframe要素の親要素に対して用いるクラスです．これにより，アスペクト比を固定しながらiframeを幅いっぱいに広げています．
    • 利用例：@pages/oc/rooms.mdx