From 4b8ce9c6cf4baece9407108819dde4ad72cd6da1 Mon Sep 17 00:00:00 2001 From: Mara Kim Date: Fri, 17 Jun 2016 09:44:19 -0500 Subject: [PATCH] Treat tabstop=8 --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f70c406..477cb68 100644 --- a/README.md +++ b/README.md @@ -33,23 +33,23 @@ See the [example project](example) used in the live demo. Properties you can pass to the console element -| Prop | Type | Description -| ---- | ---- | ---- -| autofocus? | bool | Autofocus the console on component mount. -| cancel? | function(): any | Function that should stop execution of the current command and call `this.return()`. -| complete? | function(words: string[], cursor: number, prompt: string): string[] | Return a list of possible completions given a list of (`words`), index of the word containing the cursor (`cursor`) , and the full prompt text (`prompt`). -| continue? | function(prompt: string): bool | Return a boolean indicating whether to continue asking for user input on a newline given the current prompt text (`prompt`). -| handler | function(command: string): any | Handle a command (`command`), logging data with `this.log()` or `this.logX()`, and calling `this.return()` when finished. -| promptLabel? | string | function(): string | String displayed to prompt user for input. -| welcomeMessage? | string | Initial message displayed after mount. +| Prop | Type | Description +| ---- | ---- | ---- +| autofocus? | bool | Autofocus the console on component mount. +| cancel? | function(): any | Function that should stop execution of the current command and call `this.return()`. +| complete? | function(words: string[], cursor: number, prompt: string): string[] | Return a list of possible completions given a list of (`words`), index of the word containing the cursor (`cursor`) , and the full prompt text (`prompt`). +| continue? | function(prompt: string): bool | Return a boolean indicating whether to continue asking for user input on a newline given the current prompt text (`prompt`). +| handler | function(command: string): any | Handle a command (`command`), logging data with `this.log()` or `this.logX()`, and calling `this.return()` when finished. +| promptLabel? | string | function(): string | String displayed to prompt user for input. +| welcomeMessage? | string | Initial message displayed after mount. ## Public members -| Member | Type | Description -| ---- | ---- | ---- -| log | function(...messages: any): void | Log messages to the console. If string, print the value, otherwise, print the JSON value of the message. +| Member | Type | Description +| ---- | ---- | ---- +| log | function(...messages: any): void | Log messages to the console. If string, print the value, otherwise, print the JSON value of the message. | logX | function(type: string, ...messages: any): void | Log messages of a particular type to the console. The messages will be given the class `react-console-message-{type}`. -| return | function(): void | Signal the current command has finished and a new prompt should be displayed. +| return | function(): void | Signal the current command has finished and a new prompt should be displayed. ## Awknoledgements