diff --git a/.gitignore b/.gitignore index 2be39e4..678c29b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ bower_components* bower-*.json +node_modules diff --git a/.travis.yml b/.travis.yml index f6670b0..cfac85b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,8 +7,13 @@ addons: chrome: stable before_script: - polymer lint + - >- + npm run update-types && git diff --exit-code || (echo -e + '\n\033[31mERROR:\033[0m Typings are stale. Please run "npm run + update-types".' && false) install: - npm install -g polymer-cli + - npm install - polymer install --variants script: - polymer test diff --git a/gen-tsd.json b/gen-tsd.json new file mode 100644 index 0000000..2634422 --- /dev/null +++ b/gen-tsd.json @@ -0,0 +1,5 @@ +{ + "removeReferences": [ + "../marked/lib/marked.d.ts" + ] +} diff --git a/marked-element.d.ts b/marked-element.d.ts new file mode 100644 index 0000000..a9e1ce2 --- /dev/null +++ b/marked-element.d.ts @@ -0,0 +1,208 @@ +/** + * DO NOT EDIT + * + * This file was automatically generated by + * https://github.com/Polymer/gen-typescript-declarations + * + * To modify these typings, edit the source file(s): + * marked-element.html + */ + +/// +/// + +/** + * Element wrapper for the [marked](https://github.com/chjj/marked) library. + * + * `` accepts Markdown source and renders it to a child + * element with the class `markdown-html`. This child element can be styled + * as you would a normal DOM element. If you do not provide a child element + * with the `markdown-html` class, the Markdown source will still be rendered, + * but to a shadow DOM child that cannot be styled. + * + * + * ### Markdown Content + * + * The Markdown source can be specified several ways: + * + * #### Use the `markdown` attribute to bind markdown + * + * + *
+ * + * + * #### Use ` + * + * + * #### Use ` + * + * + * Note that the ` + * + * ... + * + * ``` + * + * ### Styling + * If you are using a child with the `markdown-html` class, you can style it + * as you would a regular DOM element: + * + * [slot="markdown-html"] p { + * color: red; + * } + * + * [slot="markdown-html"] td:first-child { + * padding-left: 24px; + * } + */ +interface MarkedElementElement extends Polymer.Element { + + /** + * The markdown source that should be rendered by this element. + */ + markdown: string|null|undefined; + + /** + * Enable GFM line breaks (regular newlines instead of two spaces for breaks) + */ + breaks: boolean|null|undefined; + + /** + * Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior. + */ + pedantic: boolean|null|undefined; + + /** + * Function used to customize a renderer based on the [API specified in the Marked + * library](https://github.com/chjj/marked#overriding-renderer-methods). + * It takes one argument: a marked renderer object, which is mutated by the function. + */ + renderer: Function|null|undefined; + + /** + * Sanitize the output. Ignore any HTML that has been input. + */ + sanitize: boolean|null|undefined; + + /** + * Function used to customize a sanitize behavior. + * It takes one argument: element String without text Contents. + * + * e.g. `
` `` `

'. + * Note: To enable this function, must set `sanitize` to true. + * WARNING: If you are using this option to untrusted text, you must to prevent XSS Attacks. + */ + sanitizer: Function|null|undefined; + + /** + * If true, disables the default sanitization of any markdown received by + * a request and allows fetched unsanitized markdown + * + * e.g. fetching markdown via `src` that has HTML. + * Note: this value overrides `sanitize` if a request is made. + */ + disableRemoteSanitization: boolean|null|undefined; + + /** + * Use "smart" typographic punctuation for things like quotes and dashes. + */ + smartypants: boolean|null|undefined; + + /** + * Callback function invoked by Marked after HTML has been rendered. + * It must take two arguments: err and text and must return the resulting text. + */ + callback: Function|null|undefined; + + /** + * A reference to the XMLHttpRequest instance used to generate the + * network request. + */ + readonly xhr: XMLHttpRequest|null; + readonly outputElement: any; + ready(): void; + + /** + * Renders `markdown` to HTML when the element is attached. + * + * This serves a dual purpose: + * + * * Prevents unnecessary work (no need to render when not visible). + * + * * `attached` fires top-down, so we can give ancestors a chance to + * register listeners for the `syntax-highlight` event _before_ we render + * any markdown. + */ + attached(): void; + detached(): void; + + /** + * Unindents the markdown source that will be rendered. + */ + unindent(text: string): string; + + /** + * Renders `markdown` into this element's DOM. + * + * This is automatically called whenever the `markdown` property is changed. + * + * The only case where you should be calling this is if you are providing + * markdown via `