mirror_css/pixel-borders
1
0
Fork 0
mirror of https://github.com/NigelOToole/pixel-borders.git synced 2025-09-03 10:52:49 +02:00
Code Issues Releases Wiki Activity

Minor documentation fixes

Browse Source
This commit is contained in:
Nigel O'Toole
2019-05-30 11:27:22 +01:00
parent a91496c140
commit 449e180684
3 changed files with 165 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2016 Nigel O Toole
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

8
README.md
View File

@@ -1,5 +1,5 @@
# Pixel borders
### A SASS mixin to add pixelated borders to HTML elements, which can be customized for different sizes, styles and colour coding.
### A Sass mixin to add pixelated borders to HTML elements, which can be customized for different sizes, styles and colour coding.
### [View demo](http://nigelotoole.github.io/pixel-borders/)
@@ -13,7 +13,7 @@ $ npm install pixel-borders --save-dev
### Import
After installation you can import it into your SASS files with the statement below.
After installation you can import it into your Sass files with the statement below.
```scss
@import "node_modules/pixel-borders/src/styles/pixel-borders.scss";
@@ -96,3 +96,7 @@ Clone or download from Github.
### Credits
Inspired by the excellent [NES.css](https://nostalgic-css.github.io/NES.css/) which is a full NES-style CSS framework. Pixel borders is intended to be used where only the borders are required.
### License
MIT © Nigel O Toole

277
src/index.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Pixel borders - SASS mixin to add pixelated borders to HTML elements</title>
<title>Pixel borders - Sass mixin to add pixelated borders to HTML elements</title>
<link rel="stylesheet" href="styles/site.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Cutive+Mono|Lato:300,400">
@@ -12,8 +12,8 @@
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Press+Start+2P">
</head>
<body>
<body>
<header class="header">
<div class="container">
@@ -30,7 +30,7 @@
<div class="fullwidth">
<div class="container separator">
<h2 class="m-0">A SASS mixin to add pixelated borders to HTML elements, which can be customized for different sizes, styles and colour coding.</h2>
<h2 class="m-0">A Sass mixin to add pixelated borders to HTML elements, which can be customized for different sizes, styles and colour coding.</h2>
</div>
</div>
@@ -66,34 +66,34 @@
</div>
<div class="fullwidth">
<div class="container separator">
<div class="fullwidth">
<div class="container separator">
<div class="subsection">
<h2>Installation</h2>
<div class="subsection">
<h2>Installation</h2>
<pre>
<code>$ npm install pixel-borders --save-dev</code>
</pre>
</div>
</div>
<div class="subsection">
<h2>Usage</h2>
<div class="subsection">
<h2>Usage</h2>
<h3>Import</h3>
<h3>Import</h3>
<p>After installation you can import it into your SASS files with the statement below.</p>
<p>After installation you can import it into your Sass files with the statement below.</p>
<pre><code>@import "node_modules/pixel-borders/src/styles/pixel-borders.scss";</code></pre>
<p>You can also just import the mixins without the demo styles.</p>
<p>You can also just import the mixins without the demo styles.</p>
<pre><code>@import "node_modules/pixel-borders/src/styles/pixel-borders/pixel-borders-mixins";</code></pre>
<h4>Pixel borders mixin options</h4>
<h4>Pixel borders mixin options</h4>
<pre><code>// Add pixel borders with default options
@include pixel-borders();
@@ -120,149 +120,148 @@
);
</code></pre>
<h3>pixel-borders</h3>
<h3>pixel-borders</h3>
<table class="table">
<tr>
<th>Property</th>
<th>Default</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code>$corner-size</code></td>
<td>1</td>
<td>Number</td>
<td>Number of pixels taken out of the corner.</td>
</tr>
<tr>
<td><code>$border-size</code></td>
<td>4px</td>
<td>Number(px)</td>
<td>Border size.</td>
</tr>
<tr>
<td><code>$border-color</code></td>
<td>#000</td>
<td>Hexadecimal color</td>
<td>Border colour.</td>
</tr>
<tr>
<td><code>$border-inset-color</code></td>
<td>false</td>
<td>False/Hexadecimal color</td>
<td>Add a inset border to the bottom right in this colour.</td>
</tr>
</table>
<table class="table">
<tr>
<th>Property</th>
<th>Default</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code>$corner-size</code></td>
<td>1</td>
<td>Number</td>
<td>Number of pixels taken out of the corner.</td>
</tr>
<tr>
<td><code>$border-size</code></td>
<td>4px</td>
<td>Number(px)</td>
<td>Border size.</td>
</tr>
<tr>
<td><code>$border-color</code></td>
<td>#000</td>
<td>Hexadecimal color</td>
<td>Border colour.</td>
</tr>
<tr>
<td><code>$border-inset-color</code></td>
<td>false</td>
<td>False/Hexadecimal color</td>
<td>Add a inset border to the bottom right in this colour.</td>
</tr>
</table>
<h3>pixel-box</h3>
<h3>pixel-box</h3>
<table class="table">
<tr>
<th>Property</th>
<th>Default</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code>$corner-size</code></td>
<td></td>
<td>Number</td>
<td>Number of pixels taken out of the corner.</td>
</tr>
<tr>
<td><code>$border-size</code></td>
<td></td>
<td>Number(px)</td>
<td>Border size.</td>
</tr>
<tr>
<td><code>$background-color</code></td>
<td></td>
<td>Hexadecimal color</td>
<td>Background colour for the box, this is used as a base for colour theme.</td>
</tr>
<tr>
<td><code>$border-color</code></td>
<td>Darkened <code>$background-color</code></td>
<td>False/Hexadecimal colour</td>
<td>Border colour.</td>
</tr>
<table class="table">
<tr>
<th>Property</th>
<th>Default</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><code>$corner-size</code></td>
<td></td>
<td>Number</td>
<td>Number of pixels taken out of the corner.</td>
</tr>
<tr>
<td><code>$border-size</code></td>
<td></td>
<td>Number(px)</td>
<td>Border size.</td>
</tr>
<tr>
<td><code>$background-color</code></td>
<td></td>
<td>Hexadecimal color</td>
<td>Background colour for the box, this is used as a base for colour theme.</td>
</tr>
<tr>
<td><code>$border-color</code></td>
<td>Darkened <code>$background-color</code></td>
<td>False/Hexadecimal colour</td>
<td>Border colour.</td>
</tr>
<tr>
<td><code>$border-inset</code></td>
<td>true</td>
<td>Boolean</td>
<td>Add a inset border.</td>
</tr>
<tr>
<td><code>$border-inset-size</code></td>
<td><code>$border-size</code></td>
<td>False/Number(px)</td>
<td>Inset border size.</td>
</tr>
<tr>
<td><code>$border-inset-color</code></td>
<td>Darkened <code>$background-color</code></td>
<td>False/Hexadecimal color</td>
<td>Inset border colour.</td>
</tr>
<tr>
<td><code>$border-inset</code></td>
<td>true</td>
<td>Boolean</td>
<td>Add a inset border.</td>
</tr>
<tr>
<td><code>$border-inset-size</code></td>
<td><code>$border-size</code></td>
<td>False/Number(px)</td>
<td>Inset border size.</td>
</tr>
<tr>
<td><code>$border-inset-color</code></td>
<td>Darkened <code>$background-color</code></td>
<td>False/Hexadecimal color</td>
<td>Inset border colour.</td>
</tr>
<tr>
<td><code>$border-inset-sides</code></td>
<td>'bottom-right'</td>
<td>String</td>
<td>Which sides to add inset border to, 'all', 'top-left' or 'bottom-right'.</td>
</tr>
<tr>
<td><code>$border-inset-sides-br</code></td>
<td><code>$border-inset-color</code></td>
<td>False/Hexadecimal color</td>
<td>Bottom right inset border colour.</td>
</tr>
<tr>
<td><code>$border-inset-sides-tl</code></td>
<td>Lightened <code>$background-color</code></td>
<td>False/Hexadecimal color</td>
<td>Top left inset border colour.</td>
</tr>
</table>
<tr>
<td><code>$border-inset-sides</code></td>
<td>'bottom-right'</td>
<td>String</td>
<td>Which sides to add inset border to, 'all', 'top-left' or 'bottom-right'.</td>
</tr>
<tr>
<td><code>$border-inset-sides-br</code></td>
<td><code>$border-inset-color</code></td>
<td>False/Hexadecimal color</td>
<td>Bottom right inset border colour.</td>
</tr>
<tr>
<td><code>$border-inset-sides-tl</code></td>
<td>Lightened <code>$background-color</code></td>
<td>False/Hexadecimal color</td>
<td>Top left inset border colour.</td>
</tr>
</table>
<h3>Classes</h3>
<h3>Classes</h3>
<p>A class of .pixel-borders is applied all elements with a pixel border for demo purposes only, you should be able to add pixel borders to any elements.</p>
<p>A class of .pixel-borders is applied all elements with a pixel border for demo purposes only, you should be able to add pixel borders to any elements.</p>
<p>The pixel borders mixin comes with a number of classes defined to demonstrate how it can be used. These can be used as is but I would encourage users to create their own customized classes.</p>
<p>The pixel borders mixin comes with a number of classes defined to demonstrate how it can be used. These can be used as is but I would encourage users to create their own customized classes.</p>
</div>
</div>
<div class="subsection">
<h3>Demo site</h3>
<p>Clone or download from Github.</p>
<div class="subsection">
<h3>Demo site</h3>
<p>Clone or download from Github.</p>
<pre><code>$ npm install
$ gulp serve
</code></pre>
</div>
<div class="subsection">
<h3>Credits</h3>
<p>Inspired by the excellent <a href="https://nostalgic-css.github.io/NES.css/" target="_blank" rel="noopener">NES.css</a> which is a full NES-style CSS framework. Pixel borders is intended to be used where only the borders are required.</a>
</p>
</div>
</div>
<div class="subsection">
<h3>Credits</h3>
<p>Inspired by the excellent <a href="https://nostalgic-css.github.io/NES.css/" target="_blank" rel="noopener">NES.css</a> which is a full NES-style CSS framework. Pixel borders is intended to be used where only the borders are required.</a>
</p>
</div>
</div>
<footer class="fullwidth fullwidth--sm footer">
<div class="container">
Made by Nigel O Toole - <a href="http://www.purestructure.com" target="_blank" rel="noopener">pure structure</a>
</div>
</footer>
<footer class="fullwidth fullwidth--sm footer">
<div class="container">
Made by Nigel O Toole - <a href="http://www.purestructure.com" target="_blank" rel="noopener">pure structure</a>
</div>
</footer>
</body>
</html>