Skip to content

Commit

Permalink
markdownify Text and DateRangeInput docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Gilad Gray committed Mar 31, 2017
1 parent 3290f79 commit 608fe9b
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 43 deletions.
1 change: 0 additions & 1 deletion packages/core/src/components/_index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
@import "navbar/navbar";
@import "non-ideal-state/non-ideal-state";
@import "overlay/overlay";
@import "text/text";
@import "popover/popover";
@import "portal/portal";
@import "progress/progress-bar";
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/components/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
@page tabs
@page tabs2
@page tag
@page text
@page toast
@page tooltip
@page tree
Original file line number Diff line number Diff line change
@@ -1,28 +1,15 @@
// Copyright 2017 Palantir Technologies, Inc. All rights reserved.
// Licensed under the BSD-3 License as modified (the “License”); you may obtain a copy
// of the license at https://github.com/palantir/blueprint/blob/master/LICENSE
// and https://github.com/palantir/blueprint/blob/master/PATENTS

/*
Text
@# Text

The `Text` component adds accessible overflow behavior to a line of text by
conditionally adding the title attribute and truncating with an ellipsis when content overflows its container.

Styleguide components.text
*/

/*
JavaScript API
@##JavaScript API

The `Text` component is available in the __@blueprintjs/core__ package.
Make sure to review the [general usage docs for JS components](#components.usage).
Make sure to review the [general usage docs for JS components](#blueprint.usage).

`Text` accepts and renders arbitrary children. It is intended that these children render as text.

@interface ITextProps

@react-example TextExample
Styleguide components.text.js
*/
1 change: 0 additions & 1 deletion packages/datetime/src/blueprint-datetime.scss
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Styleguide components.datetime
*/

@import "datepicker";
@import "daterangeinput";
@import "daterangepicker";
@import "timepicker";
@import "datetimepicker";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
// Copyright 2017 Palantir Technologies, Inc. All rights reserved.
// Licensed under the BSD-3 License as modified (the “License”); you may obtain a copy
// of the license at https://github.com/palantir/blueprint/blob/master/LICENSE
// and https://github.com/palantir/blueprint/blob/master/PATENTS

@import "../../core/src/common/variables";

/*
Date range input
@# Date range input

The `DateRangeInput` component is a [control group](#components.forms.control-group) composed of two
[input groups](#components.forms.input-group). It shows a
Expand All @@ -16,13 +8,7 @@ Use this component in forms where the user must enter a date range.

@react-example DateRangeInputExample

Weight: 3
Styleguide components.datetime.daterangeinput
*/

/*
JavaScript API
@## JavaScript API

The `DateRangeInput` component is available in the __@blueprintjs/datetime__ package.
Make sure to review the [general usage docs for date & time components](#components.datetime).
Expand All @@ -40,6 +26,3 @@ import { DateRangeInput } from "@blueprintjs/datetime";
```

@interface IDateRangeInputProps
Styleguide components.datetime.daterangeinput.js
*/
13 changes: 7 additions & 6 deletions packages/datetime/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ reference: datetime

The __@blueprintjs/datetime__ NPM package provides several components for interacting with dates and times:

- [`DatePicker`](#components.datetime.datepicker) for selecting a single date (day, month, year).
- [`DatePicker`](#datetime/datepicker) for selecting a single date (day, month, year).

- [`DateRangePicker`](#components.datetime.daterangepicker) for selecting date ranges.
- [`DateRangePicker`](#datetime/daterangepicker) for selecting date ranges.

- [`TimePicker`](#components.datetime.timepicker) for selecting a time (hour, minute, second,
- [`TimePicker`](#datetime/timepicker) for selecting a time (hour, minute, second,
millisecond).

- [`DateTimePicker`](#components.datetime.datetimepicker), which composes `DatePicker` and
- [`DateTimePicker`](#datetime/datetimepicker), which composes `DatePicker` and
`TimePicker` to select a date and time together.

- [`DateInput`](#components.datetime.dateinput), which composes a text input with a `DatePicker` in
- [`DateInput`](#datetime/dateinput), which composes a text input with a `DatePicker` in
a `Popover`, for use in forms.

They are available in the __@blueprintjs/datetime__ package on
[NPM](https://www.npmjs.com/package/@blueprintjs/datetime).

Make sure to review the [general usage docs for JS components](#components.usage).
Make sure to review the [general usage docs for JS components](#blueprint.usage).

```sh
npm install --save @blueprintjs/datetime
Expand All @@ -33,3 +33,4 @@ npm install --save @blueprintjs/datetime
@page timepicker
@page datetimepicker
@page dateinput
@page daterangeinput

0 comments on commit 608fe9b

Please sign in to comment.