diff --git a/.gitignore b/.gitignore index d543f10..9d52626 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ bower_components/ node_modules/ -test/perceptual/typography.html.ignore +test/perceptual/d2l-typography.html.ignore diff --git a/.travis.yml b/.travis.yml index 71d1db7..6892e2f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,5 +1,3 @@ language: node_js node_js: stable -script: -- polylint sudo: false diff --git a/README.md b/README.md index c96f970..86f30a8 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,38 @@ -**Looking for SASS-based `vui-typography`?** It's [over here](https://github.com/Brightspace/valence-ui-typography/tree/sass). +**Looking for SASS-based `d2l-typography`?** It's [over here](https://github.com/Brightspace/d2l-typography-ui/tree/sass). -# vui-typography +# d2l-typography [![Bower version][bower-image]][bower-url] [![Build status][ci-image]][ci-url] -A Valence UI, [Polymer](https://www.polymer-project.org/1.0/)-based web component for typography styles. +A set of [Polymer](https://www.polymer-project.org/1.0/)-based web components and shared styles for applying D2L typography. -For further information on this and other VUI components, see the docs at [ui.valence.d2l.com](http://ui.valence.d2l.com/). +For further information on this and other D2L UI components, see the docs at [ui.valence.d2l.com](http://ui.valence.d2l.com/). ## Installation -`vui-typography` can be installed from [Bower][bower-url]: +`d2l-typography` can be installed from [Bower][bower-url]: ```shell -bower install vui-typography +bower install d2l-typography ``` ## Usage -Include the [webcomponents.js](http://webcomponents.org/polyfills/) "lite" polyfill (for browsers who don't natively support web components), import `typography.html`, and include the `vui-typography` style: +Include the [webcomponents.js](http://webcomponents.org/polyfills/) "lite" polyfill (for browsers who don't natively support web components), import `d2l-typography.html`, and include the `d2l-typography` shared style: ```html - - + + ``` ### Body -The `vui-typography` class can be used to set base font properties, typically applied to the `` element. +The `d2l-typography` class can be used to set base font properties, typically applied to the `` element. ```html - + ... ``` @@ -46,20 +46,20 @@ The default font family, color and line/character spacing will look like this: There are four separate classes for the available heading styles. These would typically be applied to the `

`, `

`, `

` and `

` HTML elements, though it's not a requirement. ```html -

...

-

...

-

...

-

...

+

...

+

...

+

...

+

...

``` ![screenshot of headings](/screenshots/headings.png?raw=true) ### Help Text -The custom `vui-help-text` element can be used to apply styling to help text. +The custom `d2l-help-text` element can be used to apply styling to help text. ```html -... +... ``` ### Note About Font Size @@ -78,9 +78,9 @@ In production, it's recommended to use a build tool like [Vulcanize](https://git ## Coding styles -See the [VUI Best Practices & Style Guide](https://github.com/Brightspace/valence-ui-docs/wiki/Best-Practices-&-Style-Guide) for information on VUI naming conventions, plus information about the [EditorConfig](http://editorconfig.org) rules used in this repo. +See the [Best Practices & Style Guide](https://github.com/Brightspace/valence-ui-docs/wiki/Best-Practices-&-Style-Guide) for information on naming conventions, plus information about the [EditorConfig](http://editorconfig.org) rules used in this repo. -[bower-url]: http://bower.io/search/?q=vui-typography -[bower-image]: https://img.shields.io/bower/v/vui-typography.svg -[ci-url]: https://travis-ci.org/Brightspace/valence-ui-typography -[ci-image]: https://img.shields.io/travis-ci/Brightspace/valence-ui-typography.svg +[bower-url]: http://bower.io/search/?q=d2l-typography +[bower-image]: https://img.shields.io/bower/v/d2l-typography.svg +[ci-url]: https://travis-ci.org/Brightspace/d2l-typography-ui +[ci-image]: https://img.shields.io/travis-ci/Brightspace/d2l-typography-ui.svg diff --git a/bower.json b/bower.json index 06d8469..15a2871 100644 --- a/bower.json +++ b/bower.json @@ -1,9 +1,11 @@ { - "name": "vui-typography", - "main": "typography.html", + "name": "d2l-typography", + "description": "Polymer-based web components and shared styles for applying D2L typography", + "main": "d2l-typography.html", "license": "Apache-2.0", "ignore": [ "test", + "screenshots", ".editorconfig", ".gitattributes", ".gitignore", @@ -12,6 +14,6 @@ ], "dependencies": { "d2l-colors": "^2.0.0", - "polymer": "^1.4.0" + "polymer": "^1.5.0" } } diff --git a/help-text.html b/d2l-help-text.html similarity index 52% rename from help-text.html rename to d2l-help-text.html index 35f23ea..5bc86af 100644 --- a/help-text.html +++ b/d2l-help-text.html @@ -1,21 +1,18 @@ - - - + + diff --git a/small-text.html b/d2l-typography-shared-styles.html similarity index 85% rename from small-text.html rename to d2l-typography-shared-styles.html index 51dda67..7f67642 100644 --- a/small-text.html +++ b/d2l-typography-shared-styles.html @@ -1,13 +1,11 @@ - - + diff --git a/typography.html b/d2l-typography.html similarity index 74% rename from typography.html rename to d2l-typography.html index bb79554..2c3dc0c 100644 --- a/typography.html +++ b/d2l-typography.html @@ -1,13 +1,12 @@ - - + - - +