Add ability to change text when stopping and persisting #35
Conversation
|
|
||
| ### .stopAndPersist([symbol]) | ||
| ### .stopAndPersist([symbol[, text]]) |
There was a problem hiding this comment.
Wondering if it's a better idea to use an options object here. Both symbol and text are optional and this way it's not possible to change the text without providing the symbol.
There was a problem hiding this comment.
Trying that out and it feels much nicer 👍
| Stop the spinner, change it to `symbol` (or `' '` if `symbol` is not provided) and persist the `text`. Returns the instance. See the GIF below. | ||
| Stop the spinner and change the symbol or text. Returns the instance. See the GIF below. | ||
|
|
||
| If a string is provided, it is treated as a shortcut for [`options.symbol`](#symbol). |
There was a problem hiding this comment.
I think we should just remove the symbol argument support (while still supporting it for backwards-compatibility).
|
|
||
| ##### options | ||
|
|
||
| Type: `object` |
| ###### text | ||
|
|
||
| Type: `string`<br> | ||
| Default: current `text` |
| ###### symbol | ||
|
|
||
| Type: `string`<br> | ||
| Default: `' '` |
There was a problem hiding this comment.
I don't think the default is an empty string.
There was a problem hiding this comment.
The effective default is options.symbol || ' ', or should we just say something like 'Clear the symbol'?
|
|
||
| Stop the spinner, change it to a red `✖` and persist the `text`. Returns the instance. See the GIF below. | ||
| Stop the spinner, change it to a red `✖` and persist `text` (or `.text` if `text` is not provided). Returns the instance. See the GIF below. |
There was a problem hiding this comment.
(or
.textiftextis not provided)
Not clear enough what this means. Would be better to just explain it. For example:
and persists the current text or
textif provided.
| } | ||
| stopAndPersist(symbol) { | ||
| stopAndPersist(options) { | ||
| if (typeof options === 'string') { |
There was a problem hiding this comment.
Add a comment above here with the following:
// Legacy argument
// TODO: Deprecate sometime in the future
|
Looks great. Thank you :) |
Makes it more convenient to set a new past-tense message when stopping.
(Partial implementation of #28)