Skip to content

Commit

Permalink
Merge pull request #427 from joshfrench/didrender-docs
Browse files Browse the repository at this point in the history
Update docs: didRender is defined on the card card, regardless of editing context
  • Loading branch information
bantic committed Jun 29, 2016
2 parents 31e17cf + a0c7b51 commit cb8e91f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CARDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ must be of the correct type (a DOM Node for the dom renderer, a string of html o
* `isInEditor` [boolean] - true when the card is being rendered by an editor (not being rendered for display)
* `name` [string] - the name of the card
* `onTeardown` [function] - The card can pass a callback function: `onTeardown(callbackFn)`. The callback will be called when the rendered content is torn down.
* `didRender` [function] - The card can pass a callback function: `didRender(callbackFn)`. The callback will be called when the card is rendered (on initial render and also after transitioning between display/edit states). This callback can be used to do additional work that must happen after the card's element has been appended to the DOM.

When being rendered by an editor (i.e., `env.isInEditor` is true), the env will have the following additional properties:

Expand All @@ -52,7 +53,6 @@ When being rendered by an editor (i.e., `env.isInEditor` is true), the env will
* `cancel` [function] - Called to transition from "edit" to "display" mode without changing the payload. It is a no-op if the card is in display mode already
* `remove` [function] - Removes this card from the document
* `postModel` [object] - The instance of this card's section in the editor's internal abstract tree. This can be used along with the mobiledoc-kit `postEditor` API to transform the card in other ways (for example, moving the card to a different section of the document)
* `didRender` [function] - The card can pass a callback function: `didRender(callbackFn)`. The callback will be called when the card is rendered (on initial render and also after transitioning between display/edit states). This callback can be used to do additional work that must happen after the card's element has been appended to the DOM.

## Card examples

Expand Down

0 comments on commit cb8e91f

Please sign in to comment.