stylus-helpers

v0.1.11

Published

4 years ago

mixins for writing stylus

0High
0Medium
0Low

kobaatsu

stylus

stylus helpers

これは何をするものですか

media queryやよくあるCSSルールの組み合わせをバカ正直に書くのが面倒くさいというズボラな人のための、stylus mixin集です。

.hoge
  // 透過方式で書いています
  sz 50
  sz-xs(30, 20)

.hoge {
  width: 50px;
  height: 50px;
}

@media (max-width: 767px) {
  .hoge {
    width: 30px;
    height: 20px;
  }
}

このようにコンパイルされます。

コンパイルに際してはお好きな方法でどうぞ。

インストールと使い方

インストール

npm からインストールしてください。

$npm i -D stylus-helpers

使い方

使用したいstylusファイルの先頭で @import するのが簡単でいいと思います。

@import "path/node_modules/stylus-helpers/helper"

ブレークポイント・閾値の設定

デフォルトで 4段階のmedia queryを採用しています。

xs : 0 - 767.98px
sm : 768px - 991.98px
md : 992px - 1199.98px
lg : 1200px -

これをたとえば、bootstrap4.x にあわせた5段階のmedia queryにする場合、 _shBreakPointの名前でhashでそれぞれの識別子に対応する上限値を指定し、 helper.styl ミックスインをインポートする前に指定します。

_shBreakPoint = {
  xs: 576
  sm: 768
  md: 992
  lg: 1200
  xl: Infinity
}
@import "path/node_modules/stylus-helpers/helper"

また、現在最大値は次段階の下限値から0.02pxを差し引いたものになっていますが、これをbootstrap3.xに合わせて1px差にする場合、 _shThreshold の名前で数値を設定します。

_shThreshold = 1
@import "path/node_modules/stylus-helpers/helper"

現在、xs ~ xl の5段階にしか対応していません。

主な機能

略記

よく使うcssルールの組み合わせを略記できます。

source

.hoge
  db()
  flr()
  por()

yield

.hoge {
  display: block;
  float: right;
  position: relative;
}

値指定略記

数値などを指定するルールを簡単に書けます。

source

.hoge
  h 20
  w 40%
  m()

yield

.hoge {
  height: 20px;
  width: 40%;
  margin: auto;
}

cssルールによっては単位やキーワードが補完されます。

media queryの略記

上記の略記ルールに、media queryの識別子(xs / sm / md / lg / (xl))をpostfixとして組み合わせて使います。

source

.hoge
  t 50
  t-sm 20

yield

.hoge {
  top: 50px;
}

@media (min-width:768px) and (max-width: 991px) {
  .hoge {
    top: 20px;
  }
}

media query を Block mixins として使用

stylus の標準記法 Block mixins としてmedia queryを使用できます。

source

.hoge
  width 100px  
  +xs()
    width 50px

yield

.hoge {
  width: 100px;
}

@media (max-width: 767px) {
  .hoge {
    width: 50px;
  }
}

Block mixins として使用する場合、media queryを組み合わせて上限・下限を指定することもできます。

source

.hoge
  // (下限)-(上限)で指定します
  +sm-md()
    width 100px

yield

.hoge {
  width: 100px;
}

@media (min-width:768px) and (max-width: 1199px) {
  .hoge {
    width: 100px;
  }
}

その他のmixin

bg(x, y, color) / bg-[xs|sm|md|lg|xl](x, y, color)

background-repeat を no-repeat に設定し、 background-color background-position を同時に指定します。

/* Default */
background-color: transparent; /* color */
background-repeat: no-repeat;
background-position: 50% 50%; /* x y */

br-medias()

各メディアクエリに対応した汎用 .br-** クラスを指定します。 <br> タグ専用です。

/*
  br-medias()
*/
br.br-lg,
br.br-md,
br.br-sm,
br.br-xs {
  display: none;
}
@media (min-width: 1200px) and (max-width: 1599.98px) {
  br.br-lg {
    display: block;
  }
}
@media (min-width: 992px) and (max-width: 1199.98px) {
  br.br-md {
    display: block;
  }
}
@media (min-width: 768px) and (max-width: 991.98px) {
  br.br-sm {
    display: block;
  }
}
@media (max-width: 767.98px) {
  br.br-xs {
    display: block;
  }
}

cf() / cf-[xs|sm|md|lg|xl]()

clearfixとなるCSSコードを生成します。

ellips() / ellips-[xs|sm|md|lg|xl]()

省略文字を表示するCSSコードを生成します。

fvc(align-item-keyword, flex flug) / fvc-[xs|sm|md|lg|xl](align-item-keyword, flex flug)

flexコンテナを作り、内容物を天地中央に配置します。 align-item-keyword を指定することで内容物の位置も指定できます。第2引数にfalseを指定するとdisplay: inline-flexになります。デフォルト(無指定)はdisplay: flexです。

highlighter(color, breadth, base-color) / highlighter-[xs|sm|md|lg|xl](color, breadth, base-color)

ブロック・インラインブロック下部に蛍光ペンで引いたようなアンダーラインをつけます。 background-image: linear-gradient() を使用しているので、併用はできません。

color にはカラーコードを指定します。デフォルトで lightgreen が指定されます。
breadth には線の太さを1 - 10の数値で指定します。デフォルトで 1(10%) が指定されます。
base-color には線以外の「地色」を指定します。デフォルトで transparent が指定されます。

lhx(fontSize, lineHeight) / lhx-[xs|sm|md|lg|xl](fontSize, lineHeight)

カンプ内でフォントサイズと、行間がともにピクセルなどで指定されているときにline-heightを算出します。

メディアクエリを表す接尾辞をつけることもできます。

source

.hoge
  // 単位は無視されますが、計算上揃える必要があります。
  lhx-xs(24px, 40px)

yield

@media (max-width: 767.98px) {
  .hoge {
    line-height: 1.67;
  }
}

ratio(width, h, v) / ratio-[xs|sm|md|lg|xl](width, h, v)

横幅( width デフォルトで 100% )と縦横比( h:v )を指定することで長方形（デフォルトで h = v 正方形）を作ります。
擬似要素 ::after のパディングを使って無理やり高さを出すやり方ですので、 ::after とは併用できません。

参考: レスポンシブデザインで要素の縦横比を固定する可変幅で正方形

position: relative; が指定されます。内容物に position: absolute; などを指定して使用します。

.hd
  // ブラウザ横幅いっぱいで、レスポンシブな 16:9 の長方形を作ります
  ratio(100vw, 16, 9)
.square
  // レスポンシブな正方形を作ります
  ratio()

rfz(baseFontSize, baseWindowWidth) / rfz-[xs|sm|md|lg|xl](baseFontSize, baseWindowWidth)

特定のウインドウサイズ(=baseWindowWidth)におけるフォントサイズ(=baseFontSize)を指定することで、画面サイズの変更にあわせてほぼ同じ見た目で表示するvw単位指定でのフォントサイズに変換します。

メディアクエリを表す接尾辞をつけることもできます。

source

.hoge
  // iPhone6サイズのカンプで20pxで指定されていたフォント
  rfz-xs(20, 375)

yield

@media (max-width: 767.98px) {
  .hoge {
    font-size: 5.3vw;
  }
}

sz(width, height) / sz-[xs|sm|md|lg|xl](width, height)

width height 領域を指定します。 width のみの指定で正方形の領域を指定します。デフォルトで auto になります。

trbl0() / trbl0-[xs|sm|md|lg|xl]()

box内の天地左右中央に配置される position: absolute のボックスを生成します。別途 width height の指定が必要です。

略記一覧

引数の指定 () の前にmedia queryを示す接尾辞 -xs -sm -md -lg (-xl) をつけることで、それぞれ対応する条件にのみ適用されるようになります。

値固定

| 略記 | プロパティ | 値 | | ------- | ----------------- | -------------- | | aib() | align-items | baseline | | aic() | align-items | canter | | aifs() | align-items | flex-start | | ais() | align-items | flex-start | | aife() | align-items | flex-end | | aie() | align-items | flex-end | | bdn() | border | none | | bdtn() | border-top | none | | bdrn() | border-right | none | | bdbn() | border-bottom | none | | bdln() | border-left | none | | bgn() | background | none | | bgrn() | background-repeat | none | | bgszc() | background-size | cover | | clb() | clear | both | | clr() | clear | right | | cll() | clear | left | | cln() | clear | none | | db() | display | block | | df() | display | flex | | di() | display | inline | | dib() | display | inline-block | | dif() | display | inline-flex | | dli() | display | list-item | | dn() | display | none | | dtb() | display | table | | dtbc() | display | table-cell | | dtbcl() | display | table-column | | dtbr() | display | table-row | | flr() | float | right | | fll() | float | left | | fln() | float | none | | fxdc() | flex-direction | column | | fxdcr() | flex-direction | column-reverse | | fxdr() | flex-direction | row | | fxdrr() | flex-direction | row-reverse | | fxwn() | flex-wrap | nowrap | | fxww() | flex-wrap | wrap | | fxwwr() | flex-wrap | wrap-reverse | | fwb() | font-weight | bold | | fwn() | font-weight | normal | | jcc() | justify-content | center | | jcfe() | justify-content | flex-end | | jcfs() | justify-content | flex-start | | jcsa() | justify-content | space-around | | jcsb() | justify-content | space-between | | lisn() | list-style | none | | oln() | outline | none | | offl() | object-fit | fill | | ofcn() | object-fit | contain | | ofcv() | object-fit | cover | | ofn() | object-fit | none | | ofsd() | object-fit | scale-down | | ova() | overflow | auto | | ovh() | overflow | hidden | | ovs() | overflow | scroll | | ovv() | overflow | visible | | ovxa() | overflow-x | auto | | ovxh() | overflow-x | hidden | | ovxs() | overflow-x | scroll | | ovxv() | overflow-x | visible | | ovya() | overflow-y | auto | | ovyh() | overflow-y | hidden | | ovys() | overflow-y | scroll | | ovyv() | overflow-y | visible | | poa() | position | absolute | | pof() | position | fixed | | por() | position | relative | | pos() | position | static | | poen() | pointer-events | none | | tac() | text-align | center | | tal() | text-align | left | | tar() | text-align | right | | tdl() | text-decoration | line-through | | tdn() | text-decoration | none | | tdo() | text-decoration | overline | | tdu() | text-decoration | underline | | vasup() | vertical-align | super | | vat() | vertical-align | top | | vatt() | vertical-align | text-top | | vam() | vertical-align | middle | | vabl() | vertical-align | baseline | | vab() | vertical-align | bottom | | vatb() | vertical-align | text-bottom | | vasub() | vertical-align | sub | | vh() | visibility | hidden | | vv() | visibility | visible | | wsn() | white-space | normal | | wsnw() | white-space | nowrap | | wsp() | white-space | pre |

値指定

| 略記 | プロパティ | デフォルト | 自動単位 | | -------------- | -------------------------- | ----------- | -------- | | bgsz(args) | background-size | auto | px | | bgc(color) | background-color | transparent | | | bgi(image) | background-image | | | | bgp(args) | background-potion | 50% 50% | | | fz(n) | font-size | | px | | c(color) | color | | | | ls(n) | letter-spacing | | px | | lh(n) | line-height | | | | cnt(content) | content | none | | | m(args) | margin | auto | px | | mt(n) | margin-top | auto | px | | mr(n) | margin-right | auto | px | | mb(n) | margin-bottom | auto | px | | ml(n) | margin-left | auto | px | | mx(n) | margin-right | auto | px | | | margin-left | auto | px | | pd(args)** | padding | | px | | p-xs|sm|md|lg|xl** | padding | | px | | pt(n) | padding-top | | px | | pr(n) | padding-right | | px | | pb(n) | padding-bottom | | px | | pl(n) | padding-left | | px | | px(n) | padding-right | | px | | | padding-left | | px | | t(n) | top | auto | px | | r(n) | right | auto | px | | b(n) | bottom | auto | px | | l(n) | left | auto | px | | trbl(args) | top: args[0] | auto | px | | | right: args[1] | auto | px | | | bottom: args[2] | auto | px | | | left: args[3] | auto | px | | w(n) | width | auto | px | | h(n) | height | auto | px | | bdrs(args) | border-radius | 0 | px | | bd(args) | border | | | | bdw(n) | border-width | | px | | bds(keyword) | border-style | solid | | | bdc(color) | border-color | | | | bdt(n) | border-top | | | | bdtw(n) | border-top-width | | px | | bdts(keyword) | border-top-style | solid | | | bdtc(color) | border-top-color | | | | bdr(n) | border-right | | | | bdrw(n) | border-right-width | | px | | bdrst(keyword) | border-right-style | solid | | | bdrc(color) | border-right-color | | | | bdb(n) | border-bottom | | | | bdbw(n) | border-bottom-width | | px | | bdbs(keyword) | border-bottom-style | solid | | | bdbc(color) | border-bottom-color | | | | bdl(n) | border-left | | | | bdlw(n) | border-left-width | | px | | bdls(keyword) | border-left-style | solid | | | bdlc(color) | border-left-color | | | | maw(n) | max-width | none | px | | mah(n) | max-height | none | px | | miw(n) | min-width | | px | | mih(n) | min-height | | px | | trf(args) | transform | | | | trfr(args) | transform: rotate(args) | | * | | trfrx(d) | transform: rotateX(d) | | deg | | trfry(d) | transform: rotateY(d) | | deg | | trfrz(d) | transform: rotateZ(d) | | deg | | trfsc(args) | transform: scale(args) | | * | | trfscx(n) | transform: scaleX(n) | | | | trfscy(n) | transform: scaleY(n) | | | | trfscz(n) | transform: scaleZ(n) | | | | trfsk(args) | transform: skew(args) | | * | | trfskx(d) | transform: skewX(d) | | deg | | trfsky(d) | transform: skewY(d) | | deg | | trft(args) | transform: translate(args) | | * | | trftx(val) | transform: translateX(val) | | px | | trfty(val) | transform: translateY(val) | | px | | trftz(val) | transform: translateZ(val) | | px | | fx(args) | flex | 1 | |

カンマ区切り3値または2値で指定する。1値のみの場合は同じ値が第1値第2値に適用される。 ** p() がbuiltin-functionとかぶっていたので変更 p- はメディアクエリ修飾子との組み合わせのみ使用可能

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

stylus helpers

これは何をするものですか

インストールと使い方

インストール

使い方

ブレークポイント・閾値の設定

主な機能

略記

source

yield

値指定略記

source

yield

media queryの略記

source

yield

media query を Block mixins として使用

source

yield

source

yield

その他のmixin

bg(x, y, color) / bg-[xs|sm|md|lg|xl](x, y, color)

br-medias()

cf() / cf-[xs|sm|md|lg|xl]()

ellips() / ellips-[xs|sm|md|lg|xl]()

fvc(align-item-keyword, flex flug) / fvc-[xs|sm|md|lg|xl](align-item-keyword, flex flug)

highlighter(color, breadth, base-color) / highlighter-[xs|sm|md|lg|xl](color, breadth, base-color)

lhx(fontSize, lineHeight) / lhx-[xs|sm|md|lg|xl](fontSize, lineHeight)

source

yield

ratio(width, h, v) / ratio-[xs|sm|md|lg|xl](width, h, v)

rfz(baseFontSize, baseWindowWidth) / rfz-[xs|sm|md|lg|xl](baseFontSize, baseWindowWidth)

source

yield

sz(width, height) / sz-[xs|sm|md|lg|xl](width, height)

trbl0() / trbl0-[xs|sm|md|lg|xl]()

略記一覧

値固定

値指定