Skip to content

Add date picker doc #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
grabbou merged 1 commit into from
Oct 10, 2018
Merged

Add date picker doc #271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
257 changes: 257 additions & 0 deletions src/components/datePickerIOS.rei
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,260 @@
/**

Date/time picker for ios in {{:https://facebook.github.io/react-native/docs/datepickerios} React Native DOC},
requires date and onDateChange props to be rendered:

{2 Example}

{3 default}
{[
let component = ReasonReact.statelessComponent("MyComponent");

let make = _children => {
...component,
render: _self =>
<DatePickerIOS
date=(Js.Date.fromString("February 12, 1990 17:40"))
onDateChange=(date => Js.log(date))
/>,
};
]}

Here you can find BuckleScript's {{:https://bucklescript.github.io/bucklescript/api/Js_date.html} Js.Date API}

{{:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date} The JavaScript Date API} might also be a useful resource.

{3 mode}
{[
let component = ReasonReact.statelessComponent("MyComponent");

let make = _children => {
...component,
render: _self =>
<DatePickerIOS
date=(Js.Date.fromString("February 12, 1990 17:40"))
onDateChange=(date => Js.log(date))
mode=`date
/>,
};
]}

{2 Props}

{3 date}
{[
~date: Js.Date.t
]}

{3 onDateChange}
{[
~onDateChange: Js.Date.t => unit
]}

{3 maximumDate}
{[
maximumDate: Js.Date.t=?
]}

{3 minimumDate}
{[
~minimumDate: Js.Date.t=?
]}

{3 mode}
{[
~mode: [
| `date
| `datetime
| `time
]=?
]}

{3 minuteInterval}
{[
~minuteInterval: int=?
]}

{3 timeZoneOffsetInMinutes}
{[
~timeZoneOffsetInMinutes: int=?
]}

{3 accessibilityLabel}
{[
~accessibilityLabel: ReasonReact.reactElement=?
]}

{3 accessible}
{[
~accessible: bool=?
]}

{3 hitSlop}
{[
~hitSlop: Types.insets=?
]}

{4 reference:}
Types.rei
{[
type insets = {
.
"left": int,
"right": int,
"top": int,
"bottom": int,
};
]}

{3 onAccessibilityTap}
{[
~onAccessibilityTap: unit => unit=?
]}

{3 onLayout}
{[
~onLayout: RNEvent.NativeLayoutEvent.t => unit=?
]}

{3 onMagicTap}
{[
~onMagicTap: unit => unit=?
]}

{3 responderHandlers}
{[
~responderHandlers: Types.touchResponderHandlers=?
]}

{4 reference:}
Types.rei
{[
type insets = {
.
"left": int,
"right": int,
"top": int,
"bottom": int,
};
]}

RNEvent.rei
{[
module NativeEvent: {
type t;
let changedTouches: t => array(Js.t({..}));
let identifier: t => int;
let locationX: t => float;
let locationY: t => float;
let pageX: t => float;
let pageY: t => float;
let target: t => Js.t({..});
let touches: t => array(Js.t({..}));
let timestamp: t => int;
let data: t => string;
};
]}

{3 pointerEvents}
{[
~pointerEvents: [
| `auto
| `none
| `boxNone
| `boxOnly
]=?
]}

{3 style}
{[
~style: Style.t=?
]}

{3 testID}
{[
~testID: string=?
]}

{3 accessibilityComponentType}
{[
~accessibilityComponentType: [
| `none
| `button
| `radiobutton_checked
| `radiobutton_unchecked
]=?
]}

{3 accessibilityLiveRegion}
{[
~accessibilityLiveRegion: [
| `none
| `polite
| `assertive
]=?
]}

{3 collapsable}
{[
~collapsable: bool=?
]}

{3 importantForAccessibility}
{[
~importantForAccessibility: [
| `auto
| `yes
| `no
| `noHideDescendants
]=?
]}

{3 needsOffscreenAlphaCompositing}
{[
~needsOffscreenAlphaCompositing: bool=?
]}

{3 renderToHardwareTextureAndroid}
{[
~renderToHardwareTextureAndroid: bool=?
]}

{3 accessibilityTraits}
{[
~accessibilityTraits:
list(
[
| `adjustable
| `allowsDirectInteraction
| `button
| `disabled
| `frequentUpdates
| `header
| `image
| `key
| `link
| `none
| `pageTurn
| `plays
| `search
| `selected
| `startsMedia
| `summary
| `text
],
)=?
]}

{3 accessibilityViewIsModal}
{[
~accessibilityViewIsModal: bool=?
]}

{3 accessibilityViewIsModal}
{[
~shouldRasterizeIOS: bool=?
]}
*/
let make:
(
~date: Js.Date.t,
Expand Down