diff --git a/docs/DraftChangeSet.html b/docs/DraftChangeSet.html index 100ced8f4..af01ee554 100644 --- a/docs/DraftChangeSet.html +++ b/docs/DraftChangeSet.html @@ -1,6 +1,7 @@ --- layout: docs title: DraftChangeSet +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/stores/draft-store-proxy.coffee" ---

Summary

@@ -21,8 +22,3 @@ written to the database intermittently. - - - - - diff --git a/docs/DraggableImg.html b/docs/DraggableImg.html index 272f924df..99f4cdfff 100644 --- a/docs/DraggableImg.html +++ b/docs/DraggableImg.html @@ -1,6 +1,7 @@ --- layout: docs title: DraggableImg +edit_url: "https://github.com/nylas/N1/blob/master/src/components/draggable-img.cjsx" ---

Summary

@@ -15,8 +16,3 @@ attachments) to be able to be dragged away with a preview image.

- - - - - diff --git a/docs/EventedIFrame.html b/docs/EventedIFrame.html index 0330220b6..18fd7e6bc 100644 --- a/docs/EventedIFrame.html +++ b/docs/EventedIFrame.html @@ -1,6 +1,7 @@ --- layout: docs title: EventedIFrame +edit_url: "https://github.com/nylas/N1/blob/master/src/components/evented-iframe.cjsx" ---

Summary

@@ -30,12 +31,9 @@ fired within iFrames.

documentWasReplaced()

- +

Call this method if you replace the contents of the iframe's document. This allows EventedIframe to re-attach it's event listeners.

- - - diff --git a/docs/Flexbox.html b/docs/Flexbox.html index 4fd557602..dbc4b3ce8 100644 --- a/docs/Flexbox.html +++ b/docs/Flexbox.html @@ -1,6 +1,7 @@ --- layout: docs title: Flexbox +edit_url: "https://github.com/nylas/N1/blob/master/src/components/flexbox.cjsx" ---

Summary

@@ -28,7 +29,7 @@ Any additional props you set on the Flexbox are rendered.

Optional

A String Flexbox direction: either column or row.

- + @@ -38,11 +39,7 @@ Any additional props you set on the Flexbox are rendered.

Optional

An Object with styles to apply to the flexbox.

- + - - - - diff --git a/docs/FocusTrackingRegion.html b/docs/FocusTrackingRegion.html index f8b0bcb5a..e816a09ac 100644 --- a/docs/FocusTrackingRegion.html +++ b/docs/FocusTrackingRegion.html @@ -1,6 +1,7 @@ --- layout: docs title: FocusTrackingRegion +edit_url: "https://github.com/nylas/N1/blob/master/src/components/focus-tracking-region.cjsx" ---

Summary

@@ -14,8 +15,3 @@ FocusTrackingRegion, it has an additional CSS class: focused

- - - - - diff --git a/docs/InjectedComponent.html b/docs/InjectedComponent.html index 93b08d304..e42d84999 100644 --- a/docs/InjectedComponent.html +++ b/docs/InjectedComponent.html @@ -1,6 +1,7 @@ --- layout: docs title: InjectedComponent +edit_url: "https://github.com/nylas/N1/blob/master/src/components/injected-component.cjsx" ---

Summary

@@ -34,9 +35,9 @@ is registered that matches the descriptor you provide, InjectedComponent will re matching - +

Pass an Object with ComponentRegistry descriptors. This set of descriptors is provided to ComponentRegistry::findComponentsForDescriptor to retrieve the component that will be displayed.

- + @@ -46,7 +47,7 @@ is registered that matches the descriptor you provide, InjectedComponent will re Optional

A String class name for the containing element.

- + @@ -56,11 +57,7 @@ is registered that matches the descriptor you provide, InjectedComponent will re Optional

An Object with props that will be passed to each item rendered into the set.

- + - - - - diff --git a/docs/InjectedComponentSet.html b/docs/InjectedComponentSet.html index 6f24278e5..71283b4e4 100644 --- a/docs/InjectedComponentSet.html +++ b/docs/InjectedComponentSet.html @@ -1,6 +1,7 @@ --- layout: docs title: InjectedComponentSet +edit_url: "https://github.com/nylas/N1/blob/master/src/components/injected-component-set.cjsx" ---

Summary

@@ -38,9 +39,9 @@ is registered into the location you provide, InjectedComponentSet will re-render matching - +

Pass an Object with ComponentRegistry descriptors This set of descriptors is provided to ComponentRegistry::findComponentsForDescriptor to retrieve components for display.

- + @@ -50,7 +51,7 @@ is registered into the location you provide, InjectedComponentSet will re-render Optional

A String class name for the containing element.

- + @@ -60,7 +61,7 @@ is registered into the location you provide, InjectedComponentSet will re-render Optional

Any React elements rendered inside the InjectedComponentSet will always be displayed.

- + @@ -70,7 +71,7 @@ is registered into the location you provide, InjectedComponentSet will re-render Optional

An Object with props that will be passed to each item rendered into the set.

- + @@ -80,7 +81,7 @@ is registered into the location you provide, InjectedComponentSet will re-render Optional

. Pass false to optionally remove the containers placed around injected components to isolate them from the rest of the app.

- + @@ -88,13 +89,9 @@ is registered into the location you provide, InjectedComponentSet will re-render - +

Any other props you provide, such as direction, data-column, etc. will be applied to the Flexbox rendered by the InjectedComponentSet.

- + - - - - diff --git a/docs/MenuItem.html b/docs/MenuItem.html index 7cefd0534..18f9a2808 100644 --- a/docs/MenuItem.html +++ b/docs/MenuItem.html @@ -1,6 +1,7 @@ --- layout: docs title: MenuItem +edit_url: "https://github.com/nylas/N1/blob/master/src/components/menu.cjsx" ---

Summary

@@ -28,7 +29,7 @@ MenuItem's props allow you to display dividers as well as standard items.

Optional

Pass a Boolean to render the menu item as a section divider.

- + @@ -38,7 +39,7 @@ MenuItem's props allow you to display dividers as well as standard items.

Optional

Pass a String to be the React key to optimize rendering lists of items.

- + @@ -48,7 +49,7 @@ MenuItem's props allow you to display dividers as well as standard items.

Optional

Pass a Boolean to specify whether the item is selected.

- + @@ -58,11 +59,7 @@ MenuItem's props allow you to display dividers as well as standard items.

Optional

Pass a Boolean to specify whether the item is checked.

- + - - - - diff --git a/docs/MenuManager.html b/docs/MenuManager.html index 91de061ab..59d8e4ac4 100644 --- a/docs/MenuManager.html +++ b/docs/MenuManager.html @@ -1,6 +1,7 @@ --- layout: docs title: MenuManager +edit_url: "https://github.com/nylas/N1/blob/master/src/menu-manager.coffee" ---

Summary

@@ -59,12 +60,12 @@ structure under a menu key.

add(items)

- +

Adds the given items to the application menu.

- + Parameters @@ -76,13 +77,13 @@ structure under a menu key.

items
- +

An Array of menu item Objects containing the keys:

- +
- + Returns @@ -95,11 +96,8 @@ structure under a menu key.

update()

- +

Refreshes the currently visible menu.

- - - diff --git a/docs/MenuNameEmailItem.html b/docs/MenuNameEmailItem.html index 0e9bec5f3..b006992ef 100644 --- a/docs/MenuNameEmailItem.html +++ b/docs/MenuNameEmailItem.html @@ -1,6 +1,7 @@ --- layout: docs title: MenuNameEmailItem +edit_url: "https://github.com/nylas/N1/blob/master/src/components/menu.cjsx" ---

Summary

@@ -27,7 +28,7 @@ title: MenuNameEmailItem @@ -37,11 +38,7 @@ title: MenuNameEmailItem
Optional

The String name to be displayed.

- +
Optional

The String email address to be displayed.

- +
- - - - diff --git a/docs/ModelQuery.html b/docs/ModelQuery.html index b00ddda2c..db9ccd4e7 100644 --- a/docs/ModelQuery.html +++ b/docs/ModelQuery.html @@ -1,6 +1,7 @@ --- layout: docs title: ModelQuery +edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/query.coffee" ---

Summary

@@ -41,13 +42,13 @@ query.where([Thread where(matchers) - +

Add one or more where clauses to the query

This method is chainable.

- + Parameters @@ -59,23 +60,23 @@ query.where([Threadmatchers
- +

An Array of Matcher objects that add where clauses to the underlying query.

- +
- +

include(attr)

- +

Include specific joined data attributes in result objects.

This method is chainable.

- + Parameters @@ -87,34 +88,34 @@ query.where([Threadattr
- +

A AttributeJoinedData that you want to be populated in the returned models. Note: This results in a LEFT OUTER JOIN. See AttributeJoinedData for more information.

- +
- +

includeAll()

- +

Include all of the available joined data attributes in returned models.

This method is chainable.

- - + +

order(orders)

- +

Apply a sort order to the query.

This method is chainable.

- + Parameters @@ -126,35 +127,35 @@ query.where([Threadorders
- +

An Array of one or more SortOrder objects that determine the sort order of returned models.

- +
- +

one()

- +

Set the singular flag - only one model will be returned from the query, and a LIMIT 1 clause will be used.

This method is chainable.

- - + +

limit(limit)

- +

Limit the number of query results.

This method is chainable.

- + Parameters @@ -166,22 +167,22 @@ query.where([Threadlimit
- +

Number The number of models that should be returned.

- +
- +

offset(offset)

- +

This method is chainable.

- + Parameters @@ -193,35 +194,35 @@ query.where([Threadoffset
- +

Number The start offset of the query.

- +
- +

count()

- +

Set the count flag - instead of returning inflated models, the query will return the result COUNT.

This method is chainable.

- - + +

then()

- +

Short-hand syntax that calls run().then(fn) with the provided function.

- - + + Returns @@ -234,12 +235,12 @@ query.where([Thread run() - +

- - + + Returns
@@ -249,4 +250,3 @@ query.where([Thread
- diff --git a/docs/MultiselectActionBar.html b/docs/MultiselectActionBar.html index c2fd167c1..6d8cdd477 100644 --- a/docs/MultiselectActionBar.html +++ b/docs/MultiselectActionBar.html @@ -1,6 +1,7 @@ --- layout: docs title: MultiselectActionBar +edit_url: "https://github.com/nylas/N1/blob/master/src/components/multiselect-action-bar.cjsx" ---

Summary

@@ -42,9 +43,9 @@ collection name. To add an item to the bar created in the example above, registe dataStore - +

An instance of a {ModelView}.

- + @@ -52,13 +53,9 @@ collection name. To add an item to the bar created in the example above, registe collection - +

The name of the collection. The collection name is used for the text that appears in the bar "1 thread selected" and is also used to find components in the component registry that should appear in the bar (thread => thread:BulkAtion)

- + - - - - diff --git a/docs/MultiselectList.html b/docs/MultiselectList.html index 01d6fc8a9..ffcee673b 100644 --- a/docs/MultiselectList.html +++ b/docs/MultiselectList.html @@ -1,6 +1,7 @@ --- layout: docs title: MultiselectList +edit_url: "https://github.com/nylas/N1/blob/master/src/components/multiselect-list.cjsx" ---

Summary

@@ -19,8 +20,3 @@ you provide, and also handles:

- - - - - diff --git a/docs/Popover.html b/docs/Popover.html index c64bc80b4..ac44613cf 100644 --- a/docs/Popover.html +++ b/docs/Popover.html @@ -1,6 +1,7 @@ --- layout: docs title: Popover +edit_url: "https://github.com/nylas/N1/blob/master/src/components/popover.cjsx" ---

Summary

@@ -34,8 +35,3 @@ showMyPopover: => - - - - - diff --git a/docs/ResizableRegion.html b/docs/ResizableRegion.html index 60392b5b0..00dc04ff7 100644 --- a/docs/ResizableRegion.html +++ b/docs/ResizableRegion.html @@ -1,6 +1,7 @@ --- layout: docs title: ResizableRegion +edit_url: "https://github.com/nylas/N1/blob/master/src/components/resizable-region.cjsx" ---

Summary

@@ -13,8 +14,3 @@ draggable edge. It is used throughout N1 to implement resizable columns, trays, - - - - - diff --git a/docs/RetinaImg.html b/docs/RetinaImg.html index f5016dece..68d5965b0 100644 --- a/docs/RetinaImg.html +++ b/docs/RetinaImg.html @@ -1,6 +1,7 @@ --- layout: docs title: RetinaImg +edit_url: "https://github.com/nylas/N1/blob/master/src/components/retina-img.cjsx" ---

Summary

@@ -55,9 +56,9 @@ color is declared via CSS to be the same as the button text color. Changing mode - +

(required) One of the RetinaImg.Mode constants. See above for details.

- + @@ -67,7 +68,7 @@ color is declared via CSS to be the same as the button text color. Changing Optional

A String image name to display.

- + @@ -77,7 +78,7 @@ color is declared via CSS to be the same as the button text color. Changing Optional

A String url of an image to display. May be an http, https, or nylas://<packagename>/<path within package> URL.

- + @@ -87,7 +88,7 @@ color is declared via CSS to be the same as the button text color. Changing Optional

A String image name to use when name cannot be found.

- + @@ -97,7 +98,7 @@ color is declared via CSS to be the same as the button text color. Changing Optional

Appends "-selected" to the end of the image name when when true

- + @@ -107,7 +108,7 @@ color is declared via CSS to be the same as the button text color. Changing Optional

Appends "-active" to the end of the image name when when true

- + @@ -117,7 +118,7 @@ color is declared via CSS to be the same as the button text color. Changing Optional

An Object with additional styles to apply to the image.

- + @@ -125,13 +126,9 @@ color is declared via CSS to be the same as the button text color. Changing resourcePath - +

(options) Changes the default lookup location used to find the images.

- + - - - - diff --git a/docs/Spinner.html b/docs/Spinner.html index baf8a6e47..0ab8de1f1 100644 --- a/docs/Spinner.html +++ b/docs/Spinner.html @@ -1,6 +1,7 @@ --- layout: docs title: Spinner +edit_url: "https://github.com/nylas/N1/blob/master/src/components/spinner.cjsx" ---

Summary

@@ -13,8 +14,3 @@ parent component.

- - - - - diff --git a/docs/Switch.html b/docs/Switch.html index c1ec666fb..d4671f955 100644 --- a/docs/Switch.html +++ b/docs/Switch.html @@ -1,6 +1,7 @@ --- layout: docs title: Switch +edit_url: "https://github.com/nylas/N1/blob/master/src/components/switch.cjsx" ---

Summary

@@ -14,8 +15,3 @@ Provide it with onChange and checked props just like a - - - - - diff --git a/docs/TimeoutTransitionGroupChild.html b/docs/TimeoutTransitionGroupChild.html index 17f516198..3b069ad86 100644 --- a/docs/TimeoutTransitionGroupChild.html +++ b/docs/TimeoutTransitionGroupChild.html @@ -1,6 +1,7 @@ --- layout: docs title: TimeoutTransitionGroupChild +edit_url: "https://github.com/nylas/N1/blob/master/src/components/timeout-transition-group.cjsx" ---

Summary

@@ -31,8 +32,3 @@ addons and under the Apache 2.0 License.

- - - - - diff --git a/docs/UnsafeComponent.html b/docs/UnsafeComponent.html index c2c3523f5..82361b2d9 100644 --- a/docs/UnsafeComponent.html +++ b/docs/UnsafeComponent.html @@ -1,6 +1,7 @@ --- layout: docs title: UnsafeComponent +edit_url: "https://github.com/nylas/N1/blob/master/src/components/unsafe-component.cjsx" ---

Summary

@@ -39,13 +40,9 @@ them to the wrapper div:

component - +

The React.Component to display. All other props will be passed on to this component.

- + - - - - diff --git a/docs/test.html b/docs/test.html index d01fe59cc..d475d777f 100644 --- a/docs/test.html +++ b/docs/test.html @@ -13,4 +13,3 @@ title: test.md /> </Popover> -