Skip to content

Commit

Permalink
split out scss to a separate package
Browse files Browse the repository at this point in the history
  • Loading branch information
gkay21 committed Jun 18, 2019
1 parent d93d261 commit 7b7c031
Show file tree
Hide file tree
Showing 4 changed files with 93 additions and 38 deletions.
31 changes: 31 additions & 0 deletions packages/kerosene-styles/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"name": "@kablamo/kerosene-styles",
"version": "0.0.1",
"repository": {
"type": "git",
"url": "https://github.com/KablamoOSS/kerosene.git",
"directory": "packages/kerosene-styles"
},
"bugs": {
"url": "https://github.com/KablamoOSS/kerosene/issues"
},
"homepage": "https://github.com/KablamoOSS/kerosene",
"private": false,
"license": "MIT",
"main": "lib/index.js",
"module": "es/index.js",
"sideEffects": false,
"directories": {
"doc": "readme.md"
},
"publishConfig": {
"access": "public"
},
"engines": {
"node": ">= 6"
},
"dependencies": {
"@kablamo/kerosene": "^0.0.6"
}
}

62 changes: 62 additions & 0 deletions packages/kerosene-styles/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# 🔥 Kerosene-styles

```
yarn add @kablamo/kerosene-styles
npm install @kablamo/kerosene-styles
```

## Available SCSS

---

### [media.scss](scss/mixins/media.scss)

```scss
@import '~@kablamo/kablamo-styles/scss/mixins/media.scss';
```

#### Available Functions

#### `mq(width, type)`



Returns a media query based on a width, defined by a breakpoint, as well as the min or max type.

###### Example Usage

```scss
@include mq('desktop', max) {
display: none;
}
```

###### Associated breakpoints

```scss
$breakpoints: (
"phone": 400px,
"phone-wide": 480px,
"phablet": 560px,
"tablet-small": 640px,
"tablet": 768px,
"tablet-wide": 1024px,
"desktop": 1248px,
"desktop-wide": 1440px
);
```

#### `aspect-ratio(width, height)`

Maintains the given ratio for the element it is included in.

###### Example Usage

```scss
@include aspect-ratio(16,9)
```

---

kablamo.com.au
File renamed without changes.
38 changes: 0 additions & 38 deletions packages/kerosene-ui/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,44 +88,6 @@ Returns `{ capture: true, passive: true }` when capture passive event listeners

Returns `{ capture: true }` when capture passive event listeners are supported, otherwise `true`.

## Available SCSS

### `mq(width, type)`

Returns a media query based on a width, defined by a breakpoint, as well as the min or max type.
##### Example Usage

```scss
@include mq('desktop', max) {
display: none;
}
```

##### Associated breakpoints

```scss
$breakpoints: (
"phone": 400px,
"phone-wide": 480px,
"phablet": 560px,
"tablet-small": 640px,
"tablet": 768px,
"tablet-wide": 1024px,
"desktop": 1248px,
"desktop-wide": 1440px
);
```

### `aspect-ratio(width, height)`

Maintains the given ratio for the element it is included in.

##### Example Usage

```scss
@include aspect-ratio(16,9)
```

---

kablamo.com.au

0 comments on commit 7b7c031

Please sign in to comment.