From ff8a913eb5daec1215514a969c0f86b87f40da8f Mon Sep 17 00:00:00 2001 From: Raathigeshan Kugarajan Date: Sun, 24 Apr 2016 18:54:17 +0530 Subject: [PATCH] docs(API docs): Formattings --- README.md | 4 ++-- docs/AddWidget.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 67879f1..53c167e 100644 --- a/README.md +++ b/README.md @@ -89,8 +89,8 @@ class App extends Component { | rowClass | String |CSS class name(s) that should be given to the row div element. Default is `row`. | No | | editableColumnClass | String |CSS class name(s) that should be used when a column is in editable mode. | No | | droppableColumnClass | String |CSS class name(s) that should be used when a widget is about to be dropped in a column. | No | -| frameComponent | Component | Customized frame component which should be used instead of the default frame. [More on custom frame components.](https://github.com/Raathigesh/Dazzle/blob/master/docs/ImplementingACustomFrame.md) | No | -| addWidgetComponent | Component | Customized add widget component which should be used instead of the default `AddWidgetComponent`. [More on custom add widget component.](https://github.com/Raathigesh/Dazzle/blob/master/docs/ImplementingCustomAddWidgetButton.md) | No | +| frameComponent | Component | Customized frame component which should be used instead of the default frame. [More on custom frame component.](https://github.com/Raathigesh/Dazzle/blob/master/docs/ImplementingACustomFrame.md) | No | +| addWidgetComponent | Component | Customized add widget component which should be used instead of the default AddWidget component. [More on custom add widget component.](https://github.com/Raathigesh/Dazzle/blob/master/docs/ImplementingCustomAddWidgetButton.md) | No | | addWidgetComponentText | String | Text that should be displayed in the Add Widget component. Default is `Add Widget`. | No | | onAdd(layout, rowIndex, columnIndex) | function |Will be called when user clicks the `AddWidget` component.| No | | onRemove(layout) | function |Will be called when a widget is removed.| No | diff --git a/docs/AddWidget.md b/docs/AddWidget.md index 90342a2..8925f6f 100644 --- a/docs/AddWidget.md +++ b/docs/AddWidget.md @@ -1,4 +1,4 @@ -## Add New Widget To Dashboard +## Add new widget to dashboard When add widget is clicked, `onAdd` function will be called. The `onAdd` function will be provided with the current `layout`, index of the `row` and `column` where the new widget should be added.