Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2025-01-01 13:14:16 +08:00
Code Issues Projects Releases Packages Wiki Activity

add edit urls to nylas react components

Browse source
This commit is contained in:
dillon 2015-10-03 13:56:58 -07:00
parent 5ac975c0a7
commit 4acd724fa2
21 changed files with 103 additions and 168 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/DraftChangeSet.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: DraftChangeSet
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/draft-store-proxy.coffee"
---
<h2>Summary</h2>
@ -21,8 +22,3 @@ written to the database intermittently.</li>
<ul>
</ul>

6
docs/DraggableImg.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: DraggableImg
edit_url: "https://github.com/nylas/N1/blob/master/src/components/draggable-img.cjsx"
---
<h2>Summary</h2>
@ -15,8 +16,3 @@ attachments) to be able to be dragged away with a preview image.</p>
<ul>
</ul>

6
docs/EventedIFrame.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: EventedIFrame
edit_url: "https://github.com/nylas/N1/blob/master/src/components/evented-iframe.cjsx"
---
<h2>Summary</h2>
@ -30,12 +31,9 @@ fired within iFrames.</p>
<h4 id=documentWasReplaced class="function-name">
documentWasReplaced(<span class="args"></span>) <a href="#documentWasReplaced" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Call this method if you replace the contents of the iframe&#39;s document.
This allows <a href='eventediframe.html'>EventedIframe</a> to re-attach it&#39;s event listeners.</p>
</p>
</div>

9
docs/Flexbox.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Flexbox
edit_url: "https://github.com/nylas/N1/blob/master/src/components/flexbox.cjsx"
---
<h2>Summary</h2>
@ -28,7 +29,7 @@ Any additional props you set on the Flexbox are rendered.</p>
<td>
<span class="optional">Optional</span>
<p>A <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> Flexbox direction: either <code>column</code> or <code>row</code>.</p>
</td>
</tr>
<tr>
@ -38,11 +39,7 @@ Any additional props you set on the Flexbox are rendered.</p>
<td>
<span class="optional">Optional</span>
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with styles to apply to the flexbox.</p>
</td>
</tr>
</table>

6
docs/FocusTrackingRegion.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: FocusTrackingRegion
edit_url: "https://github.com/nylas/N1/blob/master/src/components/focus-tracking-region.cjsx"
---
<h2>Summary</h2>
@ -14,8 +15,3 @@ FocusTrackingRegion, it has an additional CSS class: <code>focused</code></p>
<ul>
</ul>

13
docs/InjectedComponent.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: InjectedComponent
edit_url: "https://github.com/nylas/N1/blob/master/src/components/injected-component.cjsx"
---
<h2>Summary</h2>
@ -34,9 +35,9 @@ is registered that matches the descriptor you provide, InjectedComponent will re
<em>matching</em>
</td>
<td>
<p>Pass an <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with ComponentRegistry descriptors. This set of descriptors is provided to <a href='ComponentRegistry.html#findComponentsForDescriptor'>ComponentRegistry::findComponentsForDescriptor</a> to retrieve the component that will be displayed.</p>
</td>
</tr>
<tr>
@ -46,7 +47,7 @@ is registered that matches the descriptor you provide, InjectedComponent will re
<td>
<span class="optional">Optional</span>
<p>A <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> class name for the containing element.</p>
</td>
</tr>
<tr>
@ -56,11 +57,7 @@ is registered that matches the descriptor you provide, InjectedComponent will re
<td>
<span class="optional">Optional</span>
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with props that will be passed to each item rendered into the set.</p>
</td>
</tr>
</table>

21
docs/InjectedComponentSet.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: InjectedComponentSet
edit_url: "https://github.com/nylas/N1/blob/master/src/components/injected-component-set.cjsx"
---
<h2>Summary</h2>
@ -38,9 +39,9 @@ is registered into the location you provide, InjectedComponentSet will re-render
<em>matching</em>
</td>
<td>
<p>Pass an <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with ComponentRegistry descriptors This set of descriptors is provided to <a href='ComponentRegistry.html#findComponentsForDescriptor'>ComponentRegistry::findComponentsForDescriptor</a> to retrieve components for display.</p>
</td>
</tr>
<tr>
@ -50,7 +51,7 @@ is registered into the location you provide, InjectedComponentSet will re-render
<td>
<span class="optional">Optional</span>
<p>A <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> class name for the containing element.</p>
</td>
</tr>
<tr>
@ -60,7 +61,7 @@ is registered into the location you provide, InjectedComponentSet will re-render
<td>
<span class="optional">Optional</span>
<p>Any React elements rendered inside the InjectedComponentSet will always be displayed.</p>
</td>
</tr>
<tr>
@ -70,7 +71,7 @@ is registered into the location you provide, InjectedComponentSet will re-render
<td>
<span class="optional">Optional</span>
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with props that will be passed to each item rendered into the set.</p>
</td>
</tr>
<tr>
@ -80,7 +81,7 @@ is registered into the location you provide, InjectedComponentSet will re-render
<td>
<span class="optional">Optional</span>
<p>. Pass false to optionally remove the containers placed around injected components to isolate them from the rest of the app.</p>
</td>
</tr>
<tr>
@ -88,13 +89,9 @@ is registered into the location you provide, InjectedComponentSet will re-render
<em></em>
</td>
<td>
<p>Any other props you provide, such as <code>direction</code>, <code>data-column</code>, etc. will be applied to the <a href='flexbox.html'>Flexbox</a> rendered by the InjectedComponentSet.</p>
</td>
</tr>
</table>

13
docs/MenuItem.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: MenuItem
edit_url: "https://github.com/nylas/N1/blob/master/src/components/menu.cjsx"
---
<h2>Summary</h2>
@ -28,7 +29,7 @@ MenuItem&#39;s props allow you to display dividers as well as standard items.</p
<td>
<span class="optional">Optional</span>
<p>Pass a <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean'>Boolean</a> to render the menu item as a section divider.</p>
</td>
</tr>
<tr>
@ -38,7 +39,7 @@ MenuItem&#39;s props allow you to display dividers as well as standard items.</p
<td>
<span class="optional">Optional</span>
<p>Pass a <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> to be the React key to optimize rendering lists of items.</p>
</td>
</tr>
<tr>
@ -48,7 +49,7 @@ MenuItem&#39;s props allow you to display dividers as well as standard items.</p
<td>
<span class="optional">Optional</span>
<p>Pass a <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean'>Boolean</a> to specify whether the item is selected.</p>
</td>
</tr>
<tr>
@ -58,11 +59,7 @@ MenuItem&#39;s props allow you to display dividers as well as standard items.</p
<td>
<span class="optional">Optional</span>
<p>Pass a <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean'>Boolean</a> to specify whether the item is checked.</p>
</td>
</tr>
</table>

16
docs/MenuManager.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: MenuManager
edit_url: "https://github.com/nylas/N1/blob/master/src/menu-manager.coffee"
---
<h2>Summary</h2>
@ -59,12 +60,12 @@ structure under a <code>menu</code> key.</p>
<h4 id=add class="function-name">
add(<span class="args"><span class="arg">items</span></span>) <a href="#add" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Adds the given items to the application menu.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -76,13 +77,13 @@ structure under a <code>menu</code> key.</p>
<em>items</em>
</td>
<td class="markdown-from-sourecode">
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of menu item <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a>s containing the keys:</p>
</td>
</tr>
</table>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -95,11 +96,8 @@ structure under a <code>menu</code> key.</p>
<h4 id=update class="function-name">
update(<span class="args"></span>) <a href="#update" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Refreshes the currently visible menu. </p>
</p>
</div>

9
docs/MenuNameEmailItem.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: MenuNameEmailItem
edit_url: "https://github.com/nylas/N1/blob/master/src/components/menu.cjsx"
---
<h2>Summary</h2>
@ -27,7 +28,7 @@ title: MenuNameEmailItem
<td>
<span class="optional">Optional</span>
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> name to be displayed.</p>
</td>
</tr>
<tr>
@ -37,11 +38,7 @@ title: MenuNameEmailItem
<td>
<span class="optional">Optional</span>
<p>The <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> email address to be displayed.</p>
</td>
</tr>
</table>

82
docs/ModelQuery.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: ModelQuery
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/query.coffee"
---
<h2>Summary</h2>
@ -41,13 +42,13 @@ query.<span class="hljs-keyword">where</span>([<span class="hljs-type">Thread</s
<h4 id=where class="function-name">
where(<span class="args"><span class="arg">matchers</span></span>) <a href="#where" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Add one or more where clauses to the query</p>
<p>This method is chainable.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -59,23 +60,23 @@ query.<span class="hljs-keyword">where</span>([<span class="hljs-type">Thread</s
<em>matchers</em>
</td>
<td class="markdown-from-sourecode">
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of <a href='matcher.html'>Matcher</a> objects that add where clauses to the underlying query.</p>
</td>
</tr>
</table>
<h4 id=include class="function-name">
include(<span class="args"><span class="arg">attr</span></span>) <a href="#include" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Include specific joined data attributes in result objects.</p>
<p>This method is chainable.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -87,34 +88,34 @@ query.<span class="hljs-keyword">where</span>([<span class="hljs-type">Thread</s
<em>attr</em>
</td>
<td class="markdown-from-sourecode">
<p>A <a href='attributejoineddata.html'>AttributeJoinedData</a> that you want to be populated in the returned models. Note: This results in a LEFT OUTER JOIN. See <a href='attributejoineddata.html'>AttributeJoinedData</a> for more information.</p>
</td>
</tr>
</table>
<h4 id=includeAll class="function-name">
includeAll(<span class="args"></span>) <a href="#includeAll" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Include all of the available joined data attributes in returned models.</p>
<p>This method is chainable.</p>
</p>
</div>
<h4 id=order class="function-name">
order(<span class="args"><span class="arg">orders</span></span>) <a href="#order" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Apply a sort order to the query.</p>
<p>This method is chainable.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -126,35 +127,35 @@ query.<span class="hljs-keyword">where</span>([<span class="hljs-type">Thread</s
<em>orders</em>
</td>
<td class="markdown-from-sourecode">
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of one or more <a href='sortorder.html'>SortOrder</a> objects that determine the sort order of returned models.</p>
</td>
</tr>
</table>
<h4 id=one class="function-name">
one(<span class="args"></span>) <a href="#one" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Set the <code>singular</code> flag - only one model will be returned from the
query, and a <code>LIMIT 1</code> clause will be used.</p>
<p>This method is chainable.</p>
</p>
</div>
<h4 id=limit class="function-name">
limit(<span class="args"><span class="arg">limit</span></span>) <a href="#limit" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Limit the number of query results.</p>
<p>This method is chainable.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -166,22 +167,22 @@ query.<span class="hljs-keyword">where</span>([<span class="hljs-type">Thread</s
<em>limit</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number'>Number</a> The number of models that should be returned.</p>
</td>
</tr>
</table>
<h4 id=offset class="function-name">
offset(<span class="args"><span class="arg">offset</span></span>) <a href="#offset" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>This method is chainable.</p>
</p>
</div>
<strong>Parameters</strong>
<table class="arguments">
<tr>
@ -193,35 +194,35 @@ query.<span class="hljs-keyword">where</span>([<span class="hljs-type">Thread</s
<em>offset</em>
</td>
<td class="markdown-from-sourecode">
<p><a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number'>Number</a> The start offset of the query.</p>
</td>
</tr>
</table>
<h4 id=count class="function-name">
count(<span class="args"></span>) <a href="#count" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Set the <code>count</code> flag - instead of returning inflated models,
the query will return the result <code>COUNT</code>.</p>
<p>This method is chainable.</p>
</p>
</div>
<h4 id=then class="function-name">
then(<span class="args"></span>) <a href="#then" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p><p>Short-hand syntax that calls run().then(fn) with the provided function.</p>
</p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -234,12 +235,12 @@ query.<span class="hljs-keyword">where</span>([<span class="hljs-type">Thread</s
<h4 id=run class="function-name">
run(<span class="args"></span>) <a href="#run" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
<strong>Returns</strong>
<table class="arguments">
<tr>
@ -249,4 +250,3 @@ query.<span class="hljs-keyword">where</span>([<span class="hljs-type">Thread</s
query, or rejects with an error from the Database layer.</p>
</td></tr>
</table>

13
docs/MultiselectActionBar.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: MultiselectActionBar
edit_url: "https://github.com/nylas/N1/blob/master/src/components/multiselect-action-bar.cjsx"
---
<h2>Summary</h2>
@ -42,9 +43,9 @@ collection name. To add an item to the bar created in the example above, registe
<em>dataStore</em>
</td>
<td>
<p>An instance of a {ModelView}.</p>
</td>
</tr>
<tr>
@ -52,13 +53,9 @@ collection name. To add an item to the bar created in the example above, registe
<em>collection</em>
</td>
<td>
<p>The name of the collection. The collection name is used for the text that appears in the bar &quot;1 thread selected&quot; and is also used to find components in the component registry that should appear in the bar (<code>thread</code> =&gt; <code>thread:BulkAtion</code>)</p>
</td>
</tr>
</table>

6
docs/MultiselectList.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: MultiselectList
edit_url: "https://github.com/nylas/N1/blob/master/src/components/multiselect-list.cjsx"
---
<h2>Summary</h2>
@ -19,8 +20,3 @@ you provide, and also handles:</p>
<ul>
</ul>

6
docs/Popover.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Popover
edit_url: "https://github.com/nylas/N1/blob/master/src/components/popover.cjsx"
---
<h2>Summary</h2>
@ -34,8 +35,3 @@ showMyPopover: =&gt;
<ul>
</ul>

6
docs/ResizableRegion.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: ResizableRegion
edit_url: "https://github.com/nylas/N1/blob/master/src/components/resizable-region.cjsx"
---
<h2>Summary</h2>
@ -13,8 +14,3 @@ draggable edge. It is used throughout N1 to implement resizable columns, trays,
<ul>
</ul>

25
docs/RetinaImg.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: RetinaImg
edit_url: "https://github.com/nylas/N1/blob/master/src/components/retina-img.cjsx"
---
<h2>Summary</h2>
@ -55,9 +56,9 @@ color is declared via CSS to be the same as the button text color. Changing
<em>mode</em>
</td>
<td>
<p>(required) One of the RetinaImg.Mode constants. See above for details.</p>
</td>
</tr>
<tr>
@ -67,7 +68,7 @@ color is declared via CSS to be the same as the button text color. Changing
<td>
<span class="optional">Optional</span>
<p>A <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> image name to display.</p>
</td>
</tr>
<tr>
@ -77,7 +78,7 @@ color is declared via CSS to be the same as the button text color. Changing
<td>
<span class="optional">Optional</span>
<p>A <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> url of an image to display. May be an http, https, or <code>nylas://&lt;packagename&gt;/&lt;path within package&gt;</code> URL.</p>
</td>
</tr>
<tr>
@ -87,7 +88,7 @@ color is declared via CSS to be the same as the button text color. Changing
<td>
<span class="optional">Optional</span>
<p>A <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string'>String</a> image name to use when <code>name</code> cannot be found.</p>
</td>
</tr>
<tr>
@ -97,7 +98,7 @@ color is declared via CSS to be the same as the button text color. Changing
<td>
<span class="optional">Optional</span>
<p>Appends &quot;-selected&quot; to the end of the image name when when true</p>
</td>
</tr>
<tr>
@ -107,7 +108,7 @@ color is declared via CSS to be the same as the button text color. Changing
<td>
<span class="optional">Optional</span>
<p>Appends &quot;-active&quot; to the end of the image name when when true</p>
</td>
</tr>
<tr>
@ -117,7 +118,7 @@ color is declared via CSS to be the same as the button text color. Changing
<td>
<span class="optional">Optional</span>
<p>An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object'>Object</a> with additional styles to apply to the image.</p>
</td>
</tr>
<tr>
@ -125,13 +126,9 @@ color is declared via CSS to be the same as the button text color. Changing
<em>resourcePath</em>
</td>
<td>
<p>(options) Changes the default lookup location used to find the images.</p>
</td>
</tr>
</table>

6
docs/Spinner.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Spinner
edit_url: "https://github.com/nylas/N1/blob/master/src/components/spinner.cjsx"
---
<h2>Summary</h2>
@ -13,8 +14,3 @@ parent component.</p>
<ul>
</ul>

6
docs/Switch.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: Switch
edit_url: "https://github.com/nylas/N1/blob/master/src/components/switch.cjsx"
---
<h2>Summary</h2>
@ -14,8 +15,3 @@ Provide it with <code>onChange</code> and <code>checked</code> props just like a
<ul>
</ul>

6
docs/TimeoutTransitionGroupChild.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: TimeoutTransitionGroupChild
edit_url: "https://github.com/nylas/N1/blob/master/src/components/timeout-transition-group.cjsx"
---
<h2>Summary</h2>
@ -31,8 +32,3 @@ addons and under the Apache 2.0 License.</p>
<ul>
</ul>

9
docs/UnsafeComponent.html
View file

@ -1,6 +1,7 @@
---
layout: docs
title: UnsafeComponent
edit_url: "https://github.com/nylas/N1/blob/master/src/components/unsafe-component.cjsx"
---
<h2>Summary</h2>
@ -39,13 +40,9 @@ them to the wrapper div:</p>
<em>component</em>
</td>
<td>
<p>The <a href='https://facebook.github.io/react/docs/component-api.html'>React.Component</a> to display. All other props will be passed on to this component.</p>
</td>
</tr>
</table>

1
docs/test.html
View file

@ -13,4 +13,3 @@ title: test.md
/&gt;
&lt;/<span class="hljs-type">Popover</span>&gt;
</code></pre>