Skip to content
This repository has been archived by the owner on Mar 27, 2019. It is now read-only.

Commit

Permalink
Adjust package README script to flatten the generated HTML
Browse files Browse the repository at this point in the history 
Otherwise npm's markdown interpreter thinks the nested whitespace
means it should be a code block.
  • Loading branch information
Evan Jacobs committed Jan 25, 2017
1 parent e960458 commit 64f94a4
Show file tree
Hide file tree
Showing 22 changed files with 1,415 additions and 1,416 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Boundless</title><link href="assets/main.0b71148a41847023d5ab963be551cdcb.css" rel="stylesheet"></head><body><div id="root"></div><script src="//cdnjs.cloudflare.com/ajax/libs/react/15.4.2/react.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/react/15.4.2/react-dom.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/prism.min.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/components/prism-javascript.min.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/components/prism-bash.min.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/components/prism-jsx.min.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/components/prism-stylus.min.js"></script><script src="//cdn.polyfill.io/v2/polyfill.js?features=fetch,promise"></script><script type="text/javascript" src="assets/vendor.8db7b7506536e5ab78ee.js"></script><script type="text/javascript" src="assets/main.77f4910b46349689ddf7.js"></script></body></html><!-- Built from SHA: 9e2d80b7abf0acb11c33871c7b07aa1d114b6424 -->
<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Boundless</title><link href="assets/main.0b71148a41847023d5ab963be551cdcb.css" rel="stylesheet"></head><body><div id="root"></div><script src="//cdnjs.cloudflare.com/ajax/libs/react/15.4.2/react.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/react/15.4.2/react-dom.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/prism.min.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/components/prism-javascript.min.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/components/prism-bash.min.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/components/prism-jsx.min.js"></script><script src="//cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/components/prism-stylus.min.js"></script><script src="//cdn.polyfill.io/v2/polyfill.js?features=fetch,promise"></script><script type="text/javascript" src="assets/vendor.8db7b7506536e5ab78ee.js"></script><script type="text/javascript" src="assets/main.77f4910b46349689ddf7.js"></script></body></html><!-- Built from SHA: e9604585e115a672d5dbfa695a86cbcdce9606d8 -->
1 change: 0 additions & 1 deletion docs/assets/main.8da0bc2f8e286aec99377039444d0080.css
View file

This file was deleted.

56 changes: 28 additions & 28 deletions packages/boundless-arrow-key-navigation/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,34 @@ There are no required props.
### Optional Props

<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>
<tr>
<td>component</td>
<td><pre><code>string or function</code></pre></td>
<td><pre><code class="language-js">'div'</code></pre></td>
<td>Any valid HTML tag name or a React component factory, anything that can be passed as the first argument to `React.createElement`</td>
</tr>
<tr>
<td>defaultActiveChildIndex</td>
<td><pre><code>number</code></pre></td>
<td><pre><code class="language-js">0</code></pre></td>
<td>Allows for a particular child to be initially reachable via tabbing</td>
</tr>
<tr>
<td>mode</td>
<td><pre><code>ArrowKeyNavigation.mode.BOTH or
<tr>
<th>Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>

<tr>
<td>component</td>
<td><pre><code>string or function</code></pre></td>
<td><pre><code class="language-js">'div'</code></pre></td>
<td>Any valid HTML tag name or a React component factory, anything that can be passed as the first argument to `React.createElement`</td>
</tr>

<tr>
<td>defaultActiveChildIndex</td>
<td><pre><code>number</code></pre></td>
<td><pre><code class="language-js">0</code></pre></td>
<td>Allows for a particular child to be initially reachable via tabbing</td>
</tr>

<tr>
<td>mode</td>
<td><pre><code>ArrowKeyNavigation.mode.BOTH or
ArrowKeyNavigation.mode.HORIZONTAL or
ArrowKeyNavigation.mode.VERTICAL</code></pre></td>
<td><pre><code class="language-js">ArrowKeyNavigation.mode.BOTH</code></pre></td>
<td>controls which arrow key events are captured to move active focus within the list:
<td><pre><code class="language-js">ArrowKeyNavigation.mode.BOTH</code></pre></td>
<td>controls which arrow key events are captured to move active focus within the list:

Mode | Keys
---- | ----
Expand All @@ -57,7 +57,7 @@ Mode | Keys
`ArrowKeyNavigation.mode.VERTICAL` | ⬆️ ⬇️

_Note: focus loops when arrowing past one of the boundaries; tabbing moves the user away from the list._</td>
</tr>
</tr>

</table>

84 changes: 42 additions & 42 deletions packages/boundless-async/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,47 +20,47 @@ There are no required props.
### Optional Props

<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>
<tr>
<td>contentRenderedFunc</td>
<td><pre><code>function</code></pre></td>
<td><pre><code class="language-js">() => {}</code></pre></td>
<td>a callback for when real content has been rendered; either normal passed data or when a passed promise resolves</td>
</tr>
<tr>
<td>convertToJSXFunc</td>
<td><pre><code>function</code></pre></td>
<td><pre><code class="language-js">(x) => x</code></pre></td>
<td>a function that takes the resolved payload of a promise provided by `props.data` and returns renderable JSX; defaults to trying to render the resolved value of the Promise</td>
</tr>
<tr>
<td>data</td>
<td><pre><code>any</code></pre></td>
<td><pre><code class="language-js">null</code></pre></td>
<td>a promise, or some other piece of data to be run through `props.convertToJSXFunc`</td>
</tr>
<tr>
<td>errorContent</td>
<td><pre><code>any renderable</code></pre></td>
<td><pre><code class="language-js">'⚠️'</code></pre></td>
<td>content to be shown if the promise is rejected</td>
</tr>
<tr>
<td>loadingContent</td>
<td><pre><code>any renderable</code></pre></td>
<td><pre><code class="language-js">null</code></pre></td>
<td>content to be shown while the promise is in pending state</td>
</tr>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>

<tr>
<td>contentRenderedFunc</td>
<td><pre><code>function</code></pre></td>
<td><pre><code class="language-js">() => {}</code></pre></td>
<td>a callback for when real content has been rendered; either normal passed data or when a passed promise resolves</td>
</tr>

<tr>
<td>convertToJSXFunc</td>
<td><pre><code>function</code></pre></td>
<td><pre><code class="language-js">(x) => x</code></pre></td>
<td>a function that takes the resolved payload of a promise provided by `props.data` and returns renderable JSX; defaults to trying to render the resolved value of the Promise</td>
</tr>

<tr>
<td>data</td>
<td><pre><code>any</code></pre></td>
<td><pre><code class="language-js">null</code></pre></td>
<td>a promise, or some other piece of data to be run through `props.convertToJSXFunc`</td>
</tr>

<tr>
<td>errorContent</td>
<td><pre><code>any renderable</code></pre></td>
<td><pre><code class="language-js">'⚠️'</code></pre></td>
<td>content to be shown if the promise is rejected</td>
</tr>

<tr>
<td>loadingContent</td>
<td><pre><code>any renderable</code></pre></td>
<td><pre><code class="language-js">null</code></pre></td>
<td>content to be shown while the promise is in pending state</td>
</tr>

</table>

98 changes: 49 additions & 49 deletions packages/boundless-button/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,54 +37,54 @@ There are no required props.
### Optional Props
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>
<tr>
<td>children</td>
<td><pre><code>any renderable</code></pre></td>
<td><pre><code class="language-js">null</code></pre></td>
<td></td>
</tr>
<tr>
<td>component</td>
<td><pre><code>string or function</code></pre></td>
<td><pre><code class="language-js">'button'</code></pre></td>
<td>Any valid HTML tag name or a React component factory, anything that can be passed as the first argument to `React.createElement`</td>
</tr>
<tr>
<td>onClick</td>
<td><pre><code>function</code></pre></td>
<td><pre><code class="language-js">noop</code></pre></td>
<td></td>
</tr>
<tr>
<td>onPressed</td>
<td><pre><code>function</code></pre></td>
<td><pre><code class="language-js">noop</code></pre></td>
<td>called when the element becomes "pressed" or triggered by the user (mouse or keyboard); backing data must be updated to persist the state change; this function will still be called if `props.pressed` is not passed</td>
</tr>
<tr>
<td>onUnpressed</td>
<td><pre><code>function</code></pre></td>
<td><pre><code class="language-js">noop</code></pre></td>
<td>called when the element becomes "unpressed"; backing data must be updated to persist the state change</td>
</tr>
<tr>
<td>pressed</td>
<td><pre><code>bool</code></pre></td>
<td><pre><code class="language-js">undefined</code></pre></td>
<td>enables "pressed" support and adds the `aria-pressed` attribute to the `.b-button` node; essentially a "stateful" button (see the "unpressed/pressed" example demo above)</td>
</tr>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default Value</th>
<th>Description</th>
</tr>
<tr>
<td>children</td>
<td><pre><code>any renderable</code></pre></td>
<td><pre><code class="language-js">null</code></pre></td>
<td></td>
</tr>
<tr>
<td>component</td>
<td><pre><code>string or function</code></pre></td>
<td><pre><code class="language-js">'button'</code></pre></td>
<td>Any valid HTML tag name or a React component factory, anything that can be passed as the first argument to `React.createElement`</td>
</tr>
<tr>
<td>onClick</td>
<td><pre><code>function</code></pre></td>
<td><pre><code class="language-js">noop</code></pre></td>
<td></td>
</tr>
<tr>
<td>onPressed</td>
<td><pre><code>function</code></pre></td>
<td><pre><code class="language-js">noop</code></pre></td>
<td>called when the element becomes "pressed" or triggered by the user (mouse or keyboard); backing data must be updated to persist the state change; this function will still be called if `props.pressed` is not passed</td>
</tr>
<tr>
<td>onUnpressed</td>
<td><pre><code>function</code></pre></td>
<td><pre><code class="language-js">noop</code></pre></td>
<td>called when the element becomes "unpressed"; backing data must be updated to persist the state change</td>
</tr>
<tr>
<td>pressed</td>
<td><pre><code>bool</code></pre></td>
<td><pre><code class="language-js">undefined</code></pre></td>
<td>enables "pressed" support and adds the `aria-pressed` attribute to the `.b-button` node; essentially a "stateful" button (see the "unpressed/pressed" example demo above)</td>
</tr>
</table>
Loading

0 comments on commit 64f94a4

Please sign in to comment.