mirror of
https://github.com/Foundry376/Mailspring.git
synced 2025-01-01 13:14:16 +08:00
add edit urls to actions and attributes
This commit is contained in:
dillon
parent
4ae83ba4e3
commit
7ee48bb7d5
12 changed files with 51 additions and 78 deletions
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: Actions
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/actions.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -138,7 +139,7 @@ that is not a Store, you can still use the <code>listen</code> method provided b
|
|||
<p><em>Scope: Window</em></p>
|
||||
<pre><code><span class="hljs-comment"># Compose a reply to the last message in the thread</span>
|
||||
Actions.composeReply({threadId: <span class="hljs-string">'123'</span>})
|
||||
|
||||
|
||||
<span class="hljs-comment"># Compose a reply to a specific message in the thread</span>
|
||||
Actions.composeReply({threadId: <span class="hljs-string">'123'</span>, messageId: <span class="hljs-string">'123'</span>})
|
||||
</code></pre></p>
|
||||
|
|
@ -206,11 +207,11 @@ that is not a Store, you can still use the <code>listen</code> method provided b
|
|||
<p><em>Scope: Global</em></p>
|
||||
<pre><code><span class="hljs-comment"># A simple notification</span>
|
||||
Actions.postNotification({message: <span class="hljs-string">"Removed Thread"</span>, <span class="hljs-built_in">type</span>: <span class="hljs-string">'success'</span>})
|
||||
|
||||
|
||||
<span class="hljs-comment"># A sticky notification with actions</span>
|
||||
NOTIF_ACTION_YES = <span class="hljs-string">'YES'</span>
|
||||
NOTIF_ACTION_NO = <span class="hljs-string">'NO'</span>
|
||||
|
||||
|
||||
Actions.postNotification
|
||||
<span class="hljs-built_in">type</span>: <span class="hljs-string">'info'</span>,
|
||||
sticky: <span class="hljs-literal">true</span>
|
||||
|
|
@ -229,7 +230,7 @@ that is not a Store, you can still use the <code>listen</code> method provided b
|
|||
published via <code>postNotification</code>.</p>
|
||||
<p><em>Scope: Global</em></p>
|
||||
<pre><code><span class="hljs-variable">@_unlisten</span> = Actions.notificationActionTaken.<span class="hljs-function">listen</span>(<span class="hljs-variable">@_onActionTaken</span>, @)
|
||||
|
||||
|
||||
<span class="hljs-attribute">_onActionTaken</span>: ({notification, action}) ->
|
||||
if action.id is NOTIF_ACTION_YES
|
||||
# perform action
|
||||
|
|
@ -253,12 +254,8 @@ that is not a Store, you can still use the <code>listen</code> method provided b
|
|||
<p><em>Scope: Window</em></p>
|
||||
<pre><code>WorkspaceStore.defineSheet <span class="hljs-string">'Thread'</span>, <span class="hljs-list">{}</span>,
|
||||
list: [<span class="hljs-string">'MessageList'</span>, <span class="hljs-string">'MessageListSidebar'</span>]
|
||||
|
||||
|
||||
...
|
||||
|
||||
|
||||
@pushSheet(WorkspaceStore.Sheet.<span class="hljs-keyword">Thread</span>)
|
||||
</code></pre></p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: Attribute
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/attribute.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -25,12 +26,12 @@ The Attribute class also exposes convenience methods for generating <a href='mat
|
|||
<h4 id=equal class="function-name">
|
||||
equal(<span class="args"></span>) <a href="#equal" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -42,12 +43,12 @@ The Attribute class also exposes convenience methods for generating <a href='mat
|
|||
<h4 id=in class="function-name">
|
||||
in(<span class="args"></span>) <a href="#in" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -59,12 +60,12 @@ The Attribute class also exposes convenience methods for generating <a href='mat
|
|||
<h4 id=not class="function-name">
|
||||
not(<span class="args"></span>) <a href="#not" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -76,12 +77,12 @@ The Attribute class also exposes convenience methods for generating <a href='mat
|
|||
<h4 id=descending class="function-name">
|
||||
descending(<span class="args"></span>) <a href="#descending" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -93,12 +94,12 @@ The Attribute class also exposes convenience methods for generating <a href='mat
|
|||
<h4 id=ascending class="function-name">
|
||||
ascending(<span class="args"></span>) <a href="#ascending" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -107,4 +108,3 @@ The Attribute class also exposes convenience methods for generating <a href='mat
|
|||
<tr><td class="markdown-from-sourecode"><p>Returns an ascending <a href='sortorder.html'>SortOrder</a> for this attribute.</p>
|
||||
</td></tr>
|
||||
</table>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: AttributeBoolean
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/attribute-boolean.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -14,8 +15,3 @@ title: AttributeBoolean
|
|||
|
||||
<ul>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: AttributeCollection
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/attribute-collection.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -37,12 +38,12 @@ ORDER BY <span class="hljs-escape">`T</span>hread<span class="hljs-escape">`.</s
|
|||
<h4 id=contains class="function-name">
|
||||
contains(<span class="args"></span>) <a href="#contains" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -51,4 +52,3 @@ ORDER BY <span class="hljs-escape">`T</span>hread<span class="hljs-escape">`.</s
|
|||
<tr><td class="markdown-from-sourecode"><p>Returns a <a href='matcher.html'>Matcher</a> for objects containing the provided value.</p>
|
||||
</td></tr>
|
||||
</table>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: AttributeDateTime
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/attribute-datetime.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -22,12 +23,12 @@ title: AttributeDateTime
|
|||
<h4 id=greaterThan class="function-name">
|
||||
greaterThan(<span class="args"></span>) <a href="#greaterThan" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -39,12 +40,12 @@ title: AttributeDateTime
|
|||
<h4 id=lessThan class="function-name">
|
||||
lessThan(<span class="args"></span>) <a href="#lessThan" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -53,4 +54,3 @@ title: AttributeDateTime
|
|||
<tr><td class="markdown-from-sourecode"><p>Returns a <a href='matcher.html'>Matcher</a> for objects less than the provided value.</p>
|
||||
</td></tr>
|
||||
</table>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: AttributeJoinedData
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/attribute-joined-data.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -30,8 +31,3 @@ written to the secondary table.</p>
|
|||
|
||||
<ul>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: AttributeNumber
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/attribute-number.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -22,12 +23,12 @@ title: AttributeNumber
|
|||
<h4 id=greaterThan class="function-name">
|
||||
greaterThan(<span class="args"></span>) <a href="#greaterThan" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -39,12 +40,12 @@ title: AttributeNumber
|
|||
<h4 id=lessThan class="function-name">
|
||||
lessThan(<span class="args"></span>) <a href="#lessThan" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -53,4 +54,3 @@ title: AttributeNumber
|
|||
<tr><td class="markdown-from-sourecode"><p>Returns a <a href='matcher.html'>Matcher</a> for objects less than the provided value.</p>
|
||||
</td></tr>
|
||||
</table>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: AttributeObject
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/attribute-object.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -12,8 +13,3 @@ title: AttributeObject
|
|||
|
||||
<ul>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: AttributeServerId
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/attribute-serverid.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -14,8 +15,3 @@ title: AttributeServerId
|
|||
|
||||
<ul>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: AttributeString
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/attribute-string.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -24,12 +25,12 @@ title: AttributeString
|
|||
<h4 id=startsWith class="function-name">
|
||||
startsWith(<span class="args"></span>) <a href="#startsWith" class="link"></a>
|
||||
</h4>
|
||||
|
||||
|
||||
<div class="function-description markdown-from-sourecode">
|
||||
<p></p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<strong>Returns</strong>
|
||||
<table class="arguments">
|
||||
<tr>
|
||||
|
|
@ -38,4 +39,3 @@ title: AttributeString
|
|||
<tr><td class="markdown-from-sourecode"><p>Returns a <a href='matcher.html'>Matcher</a> for objects starting with the provided value.</p>
|
||||
</td></tr>
|
||||
</table>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: Matcher
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/matcher.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -36,8 +37,3 @@ isUnread.evaluate(threadB)
|
|||
|
||||
<ul>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
title: SortOrder
|
||||
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/attributes/sort-order.coffee"
|
||||
---
|
||||
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -18,8 +19,3 @@ instantiate SortOrders manually. Instead, call <a href='Attribute.html#ascending
|
|||
|
||||
<ul>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue