Skip to content

Commit

Permalink
Improve style prop documentation with examples
Browse files Browse the repository at this point in the history
Fixes #533
  • Loading branch information
jbalsas committed Jun 9, 2016
1 parent 6bae88c commit 8c12053
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/ui/react/src/components/base/button-style.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@
// Allows validating props being passed to the component.
propTypes: {
/**
* The style the button should handle. It can be a style object as described by http://docs.ckeditor.com/#!/api/CKEDITOR.style
* or a string pointing to an object inside the editor instance configuration
* The style the button should handle. Allowed values are:
* - Object as described by http://docs.ckeditor.com/#!/api/CKEDITOR.style.
* - String pointing to an object inside the editor instance configuration. For example, `style = 'coreStyles_bold'` will try to
* retrieve the style object from `editor.config.coreStyles_bold`. Nested properties such as `style = 'myplugin.myConfig.myStyle'`
* are also supported and will try to retrieve the style object from the editor configuration as well.
*
* @property {Object|String} style
*/
Expand Down

0 comments on commit 8c12053

Please sign in to comment.