edx-pattern-library - npm Package Compare versions

Comparing version 0.8.5 to 0.8.6

CHANGELOG.md

@@ -6,2 +6,9 @@ # Changelog
 
+- - -
+
+## 0.8.6 (2016-01-22)
+* Revised ltr/rtl config and settings to not rely on Sass @import + @if
+
+- - -
+
 ## 0.8.5 (2016-01-13)
@@ -8,0 +15,0 @@ * Added a new element, Lists - for use in content and simple navigation

package.json

 {
   "name": "edx-pattern-library",
-  "version": "0.8.5",
+  "version": "0.8.6",
   "author": "edX UX Team <[e-mail]>",
@@ -5,0 +5,0 @@ "license": "Apache-2.0",

README.md

@@ -27,4 +27,4 @@ # edX UX Pattern Library (UXPL)
 * [A working preview and documentation system for edX application UI](http://ux.edx.org) - known as "PLDOC".
-* Styleguides and standards for [general Front End](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-General), [HTML](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-HTML), [Sass/CSS](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-Sass-&-CSS), and [Accessibility-minded](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-Accessibility) development
-* Portable Sass/CSS utilities and modules for use within edX applications
+* Styleguides and standards for [general Front End](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-General), [HTML](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-HTML), [Sass/CSS](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-Sass-&-CSS), and [Accessibility-minded](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-Accessibility) development.
+* Portable Sass/CSS utilities and modules for use within edX applications.
 
@@ -34,4 +34,3 @@ ## License
 The code in this repository is licensed the Apache 2.0 license unless otherwise
-noted. Please see the [LICENSE file](https://github.com/edx/ux-pattern-
-library/blob/master/LICENSE.txt) for details.
+noted. Please see the [LICENSE file](https://github.com/edx/ux-pattern-library/blob/master/LICENSE) for details.
 
@@ -42,5 +41,5 @@ ## Dependencies
 
-* locally installing a package manager [a package manager (either [Node/npm](https://nodejs.org) or [Bower)](http://bower.io/).
+* Locally installing a package manager (either [Node/npm](https://nodejs.org) or [Bower)](http://bower.io/).
 * Use of modern web browsers - see [Open edX/edX browser support](http://docstrings.readthedocs.org/en/latest/front_matter/browsers.html)
-* the use and compilation of Sass into CSS using perferrably [LibSass](http://sass-lang.com/libsass) (if using the Sass method for including the pattern library).
+* The use and compilation of Sass into CSS using perferrably [LibSass](http://sass-lang.com/libsass) (if using the Sass method for including the pattern library).
 
@@ -156,2 +155,3 @@
 * ``http://localhost:3000/patterns/**/*`` - permalinks for individually documented pattern library patterns
+
 - - -
@@ -237,7 +237,7 @@
 
-* RTL and LTR support - noted by either a ``*-ltr`` or ``*-rtl`` suffix)
+* RTL and LTR support - noted by either a ``*-ltr`` or ``*-rtl`` suffix.
 * Minified and expanded CSS output formats - for production and development/debugging purposes respectively.
 
 **NOTE:** This way of using the edX UX Pattern Library is currently in beta is not as widely tested as the Sass method (described below). If you find bugs/issues, please [log them](#bugs-and-issues).
-.
+
 #### Reference UX Pattern Library Partials in your Sass Compile
@@ -248,3 +248,3 @@ You can also use the edX UX Pattern Library as part of your CSS's Sass compilation (**our preferred method**). To do so,
 ##### Default Reference/Import
-All components and utilities can be imported by default by importing the ``_edx-pattern-library.scss`` partial. See the example below taken from [``main-ltr.scss``]() +  the [``_build.scss``](https://github.com/edx/ux-pattern-library/blob/master/_src/pldoc/static/sass/_build.scss) compilation of the edX Pattern Library's Documentation Site:
+All components and utilities can be imported by default by importing the ``_edx-pattern-library.scss`` partial. See the expanded/simplified example below taken from [``main-ltr.scss``](https://github.com/edx/ux-pattern-library/blob/master/_src/pldoc/static/sass/_main-ltr.scss) and the [``_build.scss``](https://github.com/edx/ux-pattern-library/blob/master/_src/pldoc/static/sass/_build.scss) compilation of the edX Pattern Library's Documentation Site:
 
@@ -255,9 +255,14 @@ ```scss
 
-// About: Sass compile for the edX Pattern Library Site. This does not contain styles for other edX products/experiences (e.g. account/onboarding). Any styles defined in the partials contained here should be prefixed with ".pldoc-" to avoid cascade/run-off into the element stylings.
+// About: Sass compile for the edX Pattern Library Site. This does not contain styles for other edX products/experiences (e.g. account/onboarding).
 
 
 // ------------------------------
+// #CONFIG - layout direction
+// ------------------------------
+@import 'ltr';                                                       // LTR-specifc settings and utilities
+
+
+// ------------------------------
 // #CONFIG
 // ------------------------------
-$layout-direction: ltr;
 @import 'config';
@@ -269,4 +274,4 @@
 // ------------------------------
-@import 'lib';
-@import '{path to edx-pattern-library package}/pattern-library/sass/edx-pattern-library';
+@import 'lib';                                                      // third party libraries
+@import '../../../pattern-library/sass/edx-pattern-library';        // UXPL
 
@@ -282,3 +287,2 @@
 @import 'overrides';
-
 ```
@@ -288,2 +292,4 @@
 
+**NOTE**: We support right-to-left and left-to-right-based layouts. View more details on what [configuration and utilities are needed alongside the UXPL](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-Sass-&-CSS#right-to-left-rtl-support)
+
 See [the UX Pattern Library Files + Application Files guidelines](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-Sass-&-CSS#ux-pattern-library-files--application-files) and [example style compile](https://github.com/edx/ux-pattern-library/wiki/Styleguide:-Sass-&-CSS#main-style-compile) for more examples, details on how to use partials, and general background.
@@ -302,5 +308,10 @@
 // ------------------------------
+// #CONFIG - layout direction
+// ------------------------------
+@import 'ltr';                                                       // LTR-specifc settings and utilities
+
+
+// ------------------------------
 // #CONFIG
 // ------------------------------
-$layout-direction: ltr;
 @import 'config';
@@ -312,4 +323,3 @@
 // ------------------------------
-@import 'lib';
-@import '{path to edx-pattern-library package}/pattern-library/sass/global/core';
+@import 'lib';                                                      // third party libraries
 
@@ -316,0 +326,0 @@ // use UXPL's buttons, headings, copy, grid, and layouts

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2791811

increased by0.08%

Number of lines in readme file

406

increased by2.53%

No dependency changes