updated docs for date picker to new format #2622

Zadielerick · 2015-12-21T16:59:40Z

Need feedback. Description for value and value Link. ShowYearSelector seems to be misnamed from disableYearSelection that is passed down to Calendar. Thoughts? Also on the description of the Date Picker.

oliviertassinari · 2015-12-21T17:07:15Z

docs/src/app/components/DatePicker/ExampleDatePickers.jsx

+import Toggle from 'material-ui/lib/toggle';
+
+
+const DatePickerExamples = React.createClass({


The name is not consistent with docs/src/app/components/DatePicker/ExampleDatePickers.jsx
Can we call this class DatePickerExampleSimple and the file ExampleSimple.jsx?

Can we use the ES6 class syntax too?

@oliviertassinari Is there somewhere else with an example of ES6 class in material-ui?

Have a look at https://github.com/callemall/material-ui/blob/master/docs/src/app/components/Snackbar/ExampleTwice.jsx.

oliviertassinari · 2015-12-21T18:31:45Z

docs/src/app/components/DatePicker/ExampleSimple.jsx

+import Toggle from 'material-ui/lib/toggle';
+
+const optionsStyle = {
+  width: '300px',


That's better here 👍.
Since it's for documentation, I would say that

width: 300,

is better.

alitaheri · 2015-12-22T06:44:17Z

@Zadielerick Could you please break the example down to small examples? Also, move the folders to make a structure like this:

docs\src\app\components\pages\components\DatePicker
   README.md
   Example1...
   Example2...
   ...
   Page.jsx

Where Page.jsx is the main component of the DatePicker Page.

Then update the docs\src\app\app-routes.jsx to require this Page.jsx and rename the variable to DatePickerPage. Just as discussed here. You can take a look at #2628 too.

@oliviertassinari It's ok to work on other things now. I'll rebase if needed ^_^

oliviertassinari · 2015-12-22T21:54:34Z

src/date-picker/date-picker.jsx

    shouldDisableDate: React.PropTypes.func,
+
+    /**
+     *


Missing documentation?

@oliviertassinari Yeah, it looks like the prop name changes to disableYearSelector as it is passed down to Calendar. Not sure though, wanted to check with yall before changing this

@oliviertassinari If you follow the prop, it is passed down to date picker dialog. Here it is passed down to calendar, but calendar has no such prop, but it has disableYearSelection which isn't called anywhere else. Thought it might be misnamed.

I see now, thanks for the explaination! 😳

Should I rename?

That's definitely broken. I think that the best thing to do is to use disableYearSelection and to remove showYearSelector.
Nice finding 👍.

Zadielerick · 2015-12-22T22:39:56Z

@oliviertassinari Actually, there seems to be a bug with the toggles on the date picker component. Makes the datepicker become uncloseable, and with my pull request toggles dont do anything... Don't know whether thats good or bad...

oliviertassinari · 2015-12-22T22:44:34Z

docs/src/app/components/pages/components/DatePicker/ExampleSimple.jsx

+    this.setState(state);
+  }
+
+  _handleChange = (nill, date) => {


nill -> event?

oliviertassinari · 2015-12-22T22:47:29Z

Makes the datepicker become uncloseable

How can I reproduce this?

oliviertassinari · 2015-12-22T22:47:59Z

docs/src/app/components/pages/components/DatePicker/ExampleSimple.jsx

+    });
+  }
+
+  _handleToggle = (e, toggled) => {


I would say that event is more explicit than e.

Zadielerick · 2015-12-22T22:50:33Z

To reproduce the bug:

Go to date picker component on docs site and toggle the disable year selection toggle
Select the Inline Date Picker, click on the Year Selection at the top and change the Year
Date Picker Dialog will not close after that

oliviertassinari · 2015-12-28T16:22:01Z

docs/src/app/components/pages/components/DatePicker/ExampleInline.jsx

+import React from 'react';
+import DatePicker from 'material-ui/lib/date-picker/date-picker';
+
+export default class DatePickerExampleSimple extends React.Component {


DatePickerExampleInline

oliviertassinari · 2015-12-28T20:00:02Z

docs/src/app/components/pages/components/DatePicker/ExampleToggle.jsx

+  }
+
+  _handleToggle = (event, toggled) => {
+    let state = {};


const or you can write instead 👍

this.setState({ [event.target.name]: toggled, });

alitaheri · 2015-12-28T20:48:24Z

src/date-picker/date-picker.jsx

+
+    /**
+     * Creates a ValueLink with the value of date picker.
+     */
    valueLink: React.PropTypes.object,


@oliviertassinari Should we start deprecating this all over the place?

I was wondering. I don't think that we should do it in this PR.

you beat me to it 😆

alitaheri · 2015-12-28T20:49:45Z

@Zadielerick Such fine job 👍 👍 Thanks a lot 😁

@oliviertassinari Lets merge this for now. we should make a big PR deprecating valuLinks

Zadielerick · 2015-12-28T20:51:13Z

@alitaheri @oliviertassinari Thanks! And thanks for checking my stuff, learning a lot from yall :)

oliviertassinari · 2015-12-28T20:55:23Z

src/date-picker/date-picker.jsx

+    /**
+     *  Enables the year selection in the date picker.
+     */
+    showYearSelector: deprecated(React.PropTypes.element,


alitaheri · 2015-12-28T20:58:15Z

While you're at it. can that controlled DatePicker be somewhere else (it's own example would be good too) because it's like we have two perfectly related inline pickers and then a dialog picker. it feels inconsistent. Sorry my last one I swear 😁 😁

Zadielerick · 2015-12-28T21:00:00Z

Yeah, I wanted to incorporate the controlled date picker into an existing example or else we have 5 examples. Should I put it in another existing or make a new example for it?

alitaheri · 2015-12-28T21:03:46Z

@Zadielerick I don't think having a lot of examples is a bad thing. In fact I would like a library with a lot of examples, it will surely have something for any of my needs. I'd like to hear @oliviertassinari's thoughts on this one.

alitaheri · 2015-12-28T21:14:17Z

I'm all green 👍 👍

@oliviertassinari merge if you're good too 😁

[Docs] Update docs for date picker to new format

alitaheri · 2015-12-28T21:26:33Z

Thank you @Zadielerick, This was some hard work 👍 👍 👍 🎉 🎈

Zadielerick · 2015-12-28T21:26:55Z

:) No problem!

oliviertassinari · 2015-12-28T21:26:57Z

@Zadielerick Thanks 😄!
For the next commits, I suggest you to follow this rule Use the imperative mood in the subject line http://chris.beams.io/posts/git-commit/. IMHO This is a great material.

Zadielerick · 2015-12-28T21:32:39Z

@oliviertassinari I see, thank you!

Zadielerick force-pushed the datePickerDocsUpdate branch from d169ebb to d8e97ec Compare December 21, 2015 17:05

oliviertassinari reviewed Dec 21, 2015
View reviewed changes

oliviertassinari added the docs Improvements or additions to the documentation label Dec 21, 2015

oliviertassinari added this to the Improve the documentation milestone Dec 21, 2015

oliviertassinari added the PR: Needs Review label Dec 21, 2015

oliviertassinari mentioned this pull request Dec 21, 2015

Migration of the documentation #2433

Closed

29 tasks

Zadielerick force-pushed the datePickerDocsUpdate branch from d8e97ec to f85141f Compare December 21, 2015 17:55

oliviertassinari reviewed Dec 21, 2015
View reviewed changes

Zadielerick force-pushed the datePickerDocsUpdate branch 2 times, most recently from 46a59f3 to 4e5161e Compare December 21, 2015 20:43

oliviertassinari mentioned this pull request Dec 22, 2015

[Docs] Migrate to the new naming strategy #2628

Merged

Zadielerick force-pushed the datePickerDocsUpdate branch 3 times, most recently from 328f421 to 8cbc85c Compare December 22, 2015 16:11

oliviertassinari reviewed Dec 22, 2015
View reviewed changes

oliviertassinari reviewed Dec 28, 2015
View reviewed changes

Temp

2fabe32

Zadielerick force-pushed the datePickerDocsUpdate branch from 879b457 to 2fabe32 Compare December 28, 2015 19:54

oliviertassinari reviewed Dec 28, 2015
View reviewed changes

Updated Docs for Date Picker

839b93f

alitaheri reviewed Dec 28, 2015
View reviewed changes

alitaheri added PR: Review Accepted and removed PR: Needs Review labels Dec 28, 2015

oliviertassinari reviewed Dec 28, 2015
View reviewed changes

Updated Docs for Date Picker

30efc4d

oliviertassinari added a commit that referenced this pull request Dec 28, 2015

Merge pull request #2622 from Zadielerick/datePickerDocsUpdate

23158d9

[Docs] Update docs for date picker to new format

oliviertassinari merged commit 23158d9 into mui:master Dec 28, 2015

Zadielerick deleted the datePickerDocsUpdate branch December 28, 2015 21:26

This was referenced Sep 18, 2021

[Snyk] Security upgrade recharts from 1.8.5 to 2.1.3 ryan-ally/material-ui#19

Open

[Snyk] Security upgrade recharts from 1.8.5 to 2.1.3 hzhz/material-ui#56

Open

[Snyk] Security upgrade recharts from 1.8.5 to 2.1.3 nbv1982/material-ui#64

Open

		import Toggle from 'material-ui/lib/toggle';


		const DatePickerExamples = React.createClass({

updated docs for date picker to new format #2622

updated docs for date picker to new format #2622

Conversation

Zadielerick commented Dec 21, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alitaheri commented Dec 22, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Zadielerick commented Dec 22, 2015

Choose a reason for hiding this comment

oliviertassinari commented Dec 22, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Zadielerick commented Dec 22, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alitaheri commented Dec 28, 2015

Zadielerick commented Dec 28, 2015

Choose a reason for hiding this comment

alitaheri commented Dec 28, 2015

Zadielerick commented Dec 28, 2015

alitaheri commented Dec 28, 2015

alitaheri commented Dec 28, 2015

alitaheri commented Dec 28, 2015

Zadielerick commented Dec 28, 2015

oliviertassinari commented Dec 28, 2015

Zadielerick commented Dec 28, 2015