added openDialog() and focus() to docs

tyfoo · Oct 22, 2015 · 77f71aa · 77f71aa
1 parent 2a4ce1f
commit 77f71aa
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/src/app/components/pages/components/time-picker.jsx b/docs/src/app/components/pages/components/time-picker.jsx
@@ -63,6 +63,18 @@ let TimePickerPage = React.createClass({
  header: 'TimePicker.formatTime(time)',
  desc: 'Formats the Date object to a current component\'s time format.',
  },
+ {
+ name: 'openDialog',
+ header: 'TimePicker.openDialog()',
+ desc: 'Opens the time-picker dialog programmatically. Use this if you want to open the ' +
+ 'dialog in response to some event other than focus/tap on the input field, such as an ' +
+ 'external button click.',
+ },
+ {
+ name: 'focus',
+ header: 'TimePicker.focus()',
+ desc: 'An alias for the `openDialog()` method to allow more generic use alongside `TextField`.',
+ },
  ],
  },
  {

diff --git a/src/time-picker/time-picker.jsx b/src/time-picker/time-picker.jsx
@@ -120,6 +120,13 @@ const TimePicker = React.createClass({
  this.refs.input.setValue(this.formatTime(t));
  },
 
+ /**
+ * Alias for `openDialog()` for an api consistent with TextField.
+ */
+ focus() {
+ this.openDialog();
+ },
+
  openDialog() {
  this.setState({
  dialogTime: this.getTime(),