JarCasting
JarCasting JarCasting

px-sass-doc

WebJar for px-sass-doc

License

License

BSD 3-Clause
GroupId

GroupId

org.webjars.bowergithub.predixdesignsystem
ArtifactId

ArtifactId

px-sass-doc
Last Version

Last Version

1.0.0
Release Date

Release Date
Type

Type

jar
Description

Description

px-sass-doc
WebJar for px-sass-doc
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/predixdesignsystem/px-sass-doc

Download px-sass-doc

Filename Size
px-sass-doc-1.0.0.pom
px-sass-doc-1.0.0.jar 85 KB
px-sass-doc-1.0.0-sources.jar 22 bytes
px-sass-doc-1.0.0-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.bowergithub.predixdesignsystem/px-sass-doc/ -->
<dependency>
    <groupId>org.webjars.bowergithub.predixdesignsystem</groupId>
    <artifactId>px-sass-doc</artifactId>
    <version>1.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.bowergithub.predixdesignsystem/px-sass-doc/
implementation 'org.webjars.bowergithub.predixdesignsystem:px-sass-doc:1.0.0'
// https://jarcasting.com/artifacts/org.webjars.bowergithub.predixdesignsystem/px-sass-doc/
implementation ("org.webjars.bowergithub.predixdesignsystem:px-sass-doc:1.0.0")
'org.webjars.bowergithub.predixdesignsystem:px-sass-doc:jar:1.0.0'
<dependency org="org.webjars.bowergithub.predixdesignsystem" name="px-sass-doc" rev="1.0.0">
  <artifact name="px-sass-doc" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.bowergithub.predixdesignsystem', module='px-sass-doc', version='1.0.0')
)
libraryDependencies += "org.webjars.bowergithub.predixdesignsystem" % "px-sass-doc" % "1.0.0"
[org.webjars.bowergithub.predixdesignsystem/px-sass-doc "1.0.0"]

Dependencies

compile (12)

Group / Artifact Type Version
org.webjars.bowergithub.predixdesignsystem : px-dropdown jar [4.0.0,5)
org.webjars.bowergithub.polymerelements : marked-element jar [1.3.1,2)
org.webjars.bowergithub.polymerlabs : promise-polyfill jar [2.0.1,3)
org.webjars.bowergithub.polymer : polymer jar [1.9.0,2)
org.webjars.bowergithub.polymerelements : prism-element jar [2.0.0,3)
org.webjars.bowergithub.polymerelements : iron-collapse jar [2.0.0,3)
org.webjars.bowergithub.predixdesignsystem : px-tabs jar [1.0.0,2)
org.webjars.bowergithub.predixdesignsystem : px-toggle jar [2.0.0,3)
org.webjars.bowergithub.predixdesignsystem » px-icon-set jar [2.0.0,3)
org.webjars.bowergithub.predixdesignsystem : px-clipboard jar [1.0.0,2)
org.webjars.bowergithub.polymerelements : iron-ajax jar [2.0.0,3)
org.webjars.bowergithub.predixdesignsystem » px-theme jar [3.0.0,4)

Project Modules

There are no modules declared in this project.

px-sass-doc

Overview

Px-sass-doc is a Predix UI component used to display the Sass documentation for our Px design repositories.

Usage

Prerequisites

  1. node.js
  2. npm
  3. bower
  4. webcomponents-lite.js polyfill

Node, npm, and bower are necessary to install the component and dependencies. webcomponents.js adds support for web components and custom elements to your application.

Getting Started

First, install the component via bower on the command line:

bower install px-sass-doc --save

Second, import the component in your application with the following tag in your head:

<link rel="import" href="/bower_components/px-sass-doc/px-sass-doc.html"/>

Finally, use the component in your application:

<px-sass-doc
  library-name="px-toggle-design"
  layer="objects"
  inuit-flags='["$inuit-enable-toggle--small","$inuit-enable-toggle--large","$inuit-enable-toggle--huge"]'
  style-variables='["$inuit-toggle-color","$inuit-toggle-background","$inuit-toggle-border"]'
  dependencies='["https://github.com/PredixDev/px-colors-design","https://github.com/PredixDev/px-defaults-design","https://github.com/PredixDev/px-helpers-design"]'>
</px-sass-doc>

Documentation

Read the full API and view the demo here.

The documentation in this repository is supplemental to the official Predix documentation, which is continuously updated and maintained by the Predix documentation team. Go to http://predix.io to see the official Predix documentation.

Local Development

From the component's directory...

$ npm install
$ bower install
$ gulp sass

From the component's directory, to start a local server run:

$ gulp serve

Navigate to the root of that server (e.g. http://localhost:8080/) in a browser to open the API documentation page, with link to the "Demo" / working examples.

GE Coding Style Guide

GE JS Developer's Guide


Known Issues

Please use Github Issues to submit any bugs you might find.

org.webjars.bowergithub.predixdesignsystem

Predix Design System

Versions

Version
1.0.0