Skip to content

Commit

Permalink
[Docs]Hide internal Props
Browse files Browse the repository at this point in the history
Added @ignore tag to hide public child component from documentation
  • Loading branch information
heetvachhani committed Mar 4, 2016
1 parent b9bb7b0 commit 211fa95
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/menus/menu-item.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ const MenuItem = React.createClass({

/**
* Indicates if the menu should render with compact desktop styles.
* @ignore
*/
desktop: React.PropTypes.bool,

Expand Down
9 changes: 9 additions & 0 deletions src/table/table-body.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ const TableBody = React.createClass({
propTypes: {
/**
* Set to true to indicate that all rows should be selected.
* @ignore
*/
allRowsSelected: React.PropTypes.bool,

Expand Down Expand Up @@ -37,42 +38,49 @@ const TableBody = React.createClass({
* If true, multiple table rows can be selected.
* CTRL/CMD+Click and SHIFT+Click are valid actions.
* The default value is false.
* @ignore
*/
multiSelectable: React.PropTypes.bool,

/**
* Callback function for when a cell is clicked.
* @ignore
*/
onCellClick: React.PropTypes.func,

/**
* @ignore
* Called when a table cell is hovered. rowNumber
* is the row number of the hovered row and columnId
* is the column number or the column key of the cell.
*/
onCellHover: React.PropTypes.func,

/**
* @ignore
* Called when a table cell is no longer hovered.
* rowNumber is the row number of the row and columnId
* is the column number or the column key of the cell.
*/
onCellHoverExit: React.PropTypes.func,

/**
* @ignore
* Called when a table row is hovered.
* rowNumber is the row number of the hovered row.
*/
onRowHover: React.PropTypes.func,

/**
* @ignore
* Called when a table row is no longer
* hovered. rowNumber is the row number of the row
* that is no longer hovered.
*/
onRowHoverExit: React.PropTypes.func,

/**
* @ignore
* Called when a row is selected. selectedRows is an
* array of all row selections. IF all rows have been selected,
* the string "all" will be returned instead to indicate that
Expand All @@ -91,6 +99,7 @@ const TableBody = React.createClass({
* If true, table rows can be selected. If multiple
* row selection is desired, enable multiSelectable.
* The default value is true.
* @ignore
*/
selectable: React.PropTypes.bool,

Expand Down
1 change: 1 addition & 0 deletions src/table/table-footer.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ const TableFooter = React.createClass({
* This is mainly useful for "super header" rows so that
* the checkbox column does not create an offset that needs
* to be accounted for manually.
* @ignore
*/
adjustForCheckbox: React.PropTypes.bool,
/**
Expand Down
1 change: 1 addition & 0 deletions src/table/table-header-column.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ const TableHeaderColumn = React.createClass({

/**
* Callback function for click event.
* @ignore
*/
onClick: React.PropTypes.func,

Expand Down
2 changes: 2 additions & 0 deletions src/table/table-header.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,13 @@ const TableHeader = React.createClass({

/**
* Callback when select all has been checked.
* @ignore
*/
onSelectAll: React.PropTypes.func,

/**
* True when select all has been checked.
* @ignore
*/
selectAllSelected: React.PropTypes.bool,

Expand Down
5 changes: 5 additions & 0 deletions src/table/table-row-column.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ const TableRowColumn = React.createClass({
/**
* Number to identify the header row. This property
* is automatically populated when used with TableHeader.
* @ignore
*/
columnNumber: React.PropTypes.number,

/**
* If true, this column responds to hover events.
* @ignore
*/
hoverable: React.PropTypes.bool,

Expand All @@ -54,16 +56,19 @@ const TableRowColumn = React.createClass({

/**
* Callback function for click event.
* @ignore
*/
onClick: React.PropTypes.func,

/**
* Callback function for hover event.
* @ignore
*/
onHover: React.PropTypes.func,

/**
* Callback function for hover exit event.
* @ignore
*/
onHoverExit: React.PropTypes.func,

Expand Down
6 changes: 6 additions & 0 deletions src/table/table-row.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,38 +60,44 @@ const TableRow = React.createClass({
hovered: React.PropTypes.bool,

/**
* @ignore
* Called when a row cell is clicked.
* rowNumber is the row number and columnId is
* the column number or the column key.
*/
onCellClick: React.PropTypes.func,

/**
* @ignore
* Called when a table cell is hovered.
* rowNumber is the row number of the hovered row
* and columnId is the column number or the column key of the cell.
*/
onCellHover: React.PropTypes.func,

/**
* @ignore
* Called when a table cell is no longer hovered.
* rowNumber is the row number of the row and columnId
* is the column number or the column key of the cell.
*/
onCellHoverExit: React.PropTypes.func,

/**
* @ignore
* Called when row is clicked.
*/
onRowClick: React.PropTypes.func,

/**
* @ignore
* Called when a table row is hovered.
* rowNumber is the row number of the hovered row.
*/
onRowHover: React.PropTypes.func,

/**
* @ignore
* Called when a table row is no longer hovered.
* rowNumber is the row number of the row that is no longer hovered.
*/
Expand Down
3 changes: 3 additions & 0 deletions src/tabs/tab.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,12 @@ const Tab = React.createClass({

/**
* This property is overriden by the Tabs component.
* @ignore
*/
onTouchTap: React.PropTypes.func,

/**
* @ignore
* Defines if the current tab is selected or not.
* The Tabs component is responsible for setting this property.
*/
Expand All @@ -69,6 +71,7 @@ const Tab = React.createClass({
value: React.PropTypes.any,

/**
* @ignore
* This property is overriden by the Tabs component.
*/
width: React.PropTypes.string,
Expand Down

0 comments on commit 211fa95

Please sign in to comment.