From e53895f79c32e74b03c33d3da50ecffc98c6bed4 Mon Sep 17 00:00:00 2001 From: dillon Date: Sat, 3 Oct 2015 14:24:10 -0700 Subject: [PATCH] add edit urls for menu and package manager --- docs/Menu.html | 38 ++++---- docs/PackageManager.html | 184 +++++++++++++++++++-------------------- 2 files changed, 109 insertions(+), 113 deletions(-) diff --git a/docs/Menu.html b/docs/Menu.html index 1fcc1fa1a..95953790a 100644 --- a/docs/Menu.html +++ b/docs/Menu.html @@ -1,6 +1,7 @@ --- layout: docs title: Menu +edit_url: "https://github.com/nylas/N1/blob/master/src/components/menu.cjsx" ---

Summary

@@ -46,7 +47,7 @@ component's Menu instance:

Optional

The String class name applied to the Menu

- + @@ -54,9 +55,9 @@ component's Menu instance:

itemContent - +

A Function that returns a MenuItem, String, or React component for the given item. If you return a MenuItem, your item is injected into the list directly. If you return a string or React component, the result is placed within a MenuItem, resulting in the following DOM: <div className="item [selected]">{your content}</div>. To create dividers and other special menu items, return an instance of:

- + @@ -64,9 +65,9 @@ component's Menu instance:

itemKey - +

A Function that returns a unique string key for the given item. Keys are important for efficient React rendering when items is changed, and a key function is required.

- + @@ -74,9 +75,9 @@ component's Menu instance:

itemChecked - +

A Function that returns true if the given item should be shown with a checkmark. If you don't provide an implementation for itemChecked, no checkmarks are ever shown.

- + @@ -84,9 +85,9 @@ component's Menu instance:

items - +

An Array of arbitrary objects the menu should display.

- + @@ -94,9 +95,9 @@ component's Menu instance:

onSelect - +

A Function called with the selected item when the user clicks an item in the menu or confirms their selection with the Enter key.

- + @@ -104,9 +105,9 @@ component's Menu instance:

defaultSelectedIndex - +

The index of the item first selected if there was no other previous index. Defaults to 0. Set to -1 if you want nothing selected.

- + @@ -119,12 +120,12 @@ component's Menu instance:

getSelectedItem()

- +

- - + + Returns @@ -136,12 +137,9 @@ component's Menu instance:

setSelectedItem()

- +

Set the currently selected item. Pass null to remove the selection

- - - diff --git a/docs/PackageManager.html b/docs/PackageManager.html index 6b7df846b..6a7c946fd 100644 --- a/docs/PackageManager.html +++ b/docs/PackageManager.html @@ -1,6 +1,7 @@ --- layout: docs title: PackageManager +edit_url: "https://github.com/nylas/N1/blob/master/src/package-manager.coffee" ---

Summary

@@ -42,12 +43,12 @@ settings and also by calling enablePackage()/disablePackage().

onDidLoadInitialPackages(callback)

- +

Invoke the given callback when all packages have been loaded.

- + Parameters
@@ -59,13 +60,13 @@ settings and also by calling enablePackage()/disablePackage().

callback
- +

Function

- +
- + Returns @@ -77,12 +78,12 @@ settings and also by calling enablePackage()/disablePackage().

onDidActivateInitialPackages(callback)

- +

Invoke the given callback when all packages have been activated.

- + Parameters
@@ -94,13 +95,13 @@ settings and also by calling enablePackage()/disablePackage().

callback
- +

Function

- +
- + Returns @@ -112,12 +113,12 @@ settings and also by calling enablePackage()/disablePackage().

onDidActivatePackage(callback)

- +

Invoke the given callback when a package is activated.

- + Parameters
@@ -129,13 +130,13 @@ settings and also by calling enablePackage()/disablePackage().

callback
- +

A Function to be invoked when a package is activated.

- +
- + Returns @@ -147,12 +148,12 @@ settings and also by calling enablePackage()/disablePackage().

onDidDeactivatePackage(callback)

- +

Invoke the given callback when a package is deactivated.

- + Parameters
@@ -164,13 +165,13 @@ settings and also by calling enablePackage()/disablePackage().

callback
- +

A Function to be invoked when a package is deactivated.

- +
- + Returns @@ -182,12 +183,12 @@ settings and also by calling enablePackage()/disablePackage().

onDidLoadPackage(callback)

- +

Invoke the given callback when a package is loaded.

- + Parameters
@@ -199,13 +200,13 @@ settings and also by calling enablePackage()/disablePackage().

callback
- +

A Function to be invoked when a package is loaded.

- +
- + Returns @@ -217,12 +218,12 @@ settings and also by calling enablePackage()/disablePackage().

onDidUnloadPackage(callback)

- +

Invoke the given callback when a package is unloaded.

- + Parameters
@@ -234,13 +235,13 @@ settings and also by calling enablePackage()/disablePackage().

callback
- +

A Function to be invoked when a package is unloaded.

- +
- + Returns @@ -252,24 +253,24 @@ settings and also by calling enablePackage()/disablePackage().

getApmPath()

- +

Get the path to the apm command.

Return a String file path to apm.

- - + +

getPackageDirPaths()

- +

Get the paths being used to look for packages.

- - + + Returns
@@ -281,13 +282,13 @@ settings and also by calling enablePackage()/disablePackage().

resolvePackagePath(name)

- +

Resolve the given package name to a path on disk.

Return a String folder path or undefined if it could not be resolved.

- + Parameters
@@ -299,22 +300,22 @@ settings and also by calling enablePackage()/disablePackage().

name
- +

The String package name.

- +
- +

isBundledPackage(name)

- +

Is the package with the given name bundled with Atom?

- + Parameters @@ -326,13 +327,13 @@ settings and also by calling enablePackage()/disablePackage().

name
- +

The String package name.

- +
- + Returns @@ -344,13 +345,13 @@ settings and also by calling enablePackage()/disablePackage().

enablePackage()

- +

Enable the package with the given name.

- - + + Returns
@@ -362,13 +363,13 @@ settings and also by calling enablePackage()/disablePackage().

disablePackage()

- +

Disable the package with the given name.

- - + + Returns
@@ -380,12 +381,12 @@ settings and also by calling enablePackage()/disablePackage().

isPackageDisabled(name)

- +

Is the package with the given name disabled?

- + Parameters
@@ -397,13 +398,13 @@ settings and also by calling enablePackage()/disablePackage().

name
- +

The String package name.

- +
- + Returns @@ -415,22 +416,22 @@ settings and also by calling enablePackage()/disablePackage().

getActivePackages()

- +

Get an Array of all the active {Package}s.

- - + +

getActivePackage(name)

- +

Get the active {Package} with the given name.

- + Parameters
@@ -442,13 +443,13 @@ settings and also by calling enablePackage()/disablePackage().

name
- +

The String package name.

- +
- + Returns @@ -460,12 +461,12 @@ settings and also by calling enablePackage()/disablePackage().

isPackageActive(name)

- +

Is the {Package} with the given name active?

- + Parameters
@@ -477,13 +478,13 @@ settings and also by calling enablePackage()/disablePackage().

name
- +

The String package name.

- +
- + Returns @@ -495,22 +496,22 @@ settings and also by calling enablePackage()/disablePackage().

getLoadedPackages()

- +

Get an Array of all the loaded {Package}s

- - + +

getLoadedPackage(name)

- +

Get the loaded {Package} with the given name.

- + Parameters
@@ -522,13 +523,13 @@ settings and also by calling enablePackage()/disablePackage().

name
- +

The String package name.

- +
- + Returns @@ -540,12 +541,12 @@ settings and also by calling enablePackage()/disablePackage().

isPackageLoaded(name)

- +

Is the package with the given name loaded?

- + Parameters
@@ -557,13 +558,13 @@ settings and also by calling enablePackage()/disablePackage().

name
- +

The String package name.

- +
- + Returns @@ -575,33 +576,30 @@ settings and also by calling enablePackage()/disablePackage().

getAvailablePackagePaths()

- +

Get an Array of Strings of all the available package paths.

If the optional windowType is passed, it will only load packages that declare that windowType in their package.json

- - + +

getAvailablePackageNames()

- +

Get an Array of Strings of all the available package names.

- - + +

getAvailablePackageMetadata()

- +

Get an Array of Strings of all the available package metadata.

- - -