[docs] refactor content to focus on React usage #2574

giladgray · 2018-06-06T21:10:58Z

Fixes #2465, Fixes #2542

Changes proposed in this pull request:

refactor Core Components & Overlays documentation content to focus on React usage (Forms and other packages will happen in separate PRs)

giladgray · 2018-06-06T21:12:01Z

packages/core/src/components/button/button-group.md

+`Button`s inside a `ButtonGroup` can optionally be wrapped with a [`Popover`](#core/components/popover). The following example demonstrates this composition:
+
+```tsx
+<ButtonGroup className={Classes.ALIGN_LEFT}>


there's an alignText prop

tho i'm not convinced this code sample is helpful at all.

giladgray · 2018-06-06T21:12:37Z

packages/core/src/components/button/button-group.md

+It exposes shorthand props for CSS modifier classes and supports the full range of HTML props.
+
+```tsx
+<ButtonGroup minimal={true} large={false} onMouseEnter={...}>


large={false} is default, remove

giladgray · 2018-06-06T21:13:09Z

packages/core/src/components/button/button-group.md

 </div>

-@interface IButtonGroupProps
+@css button-group-vertical


these css examples should be refactored

giladgray · 2018-06-06T21:13:36Z

packages/core/src/components/card/card.md

@@ -21,24 +39,3 @@ changes to a pointer and increases the elevation shadow on the card.
 Users expect an interactive card to be a single clickable unit.

 @css card-interactive


can merge this with other css example

giladgray · 2018-06-06T21:13:41Z

packages/core/src/components/collapsible-list/collapsible-list.md

@@ -7,7 +7,7 @@ props from the `MenuItem` children.

 @reactExample CollapsibleListExample

-@## JavaScript API
+@## Props

 The `CollapsibleList` component is available in the __@blueprintjs/core__ package.


giladgray · 2018-06-06T21:14:20Z

packages/core/src/components/collapsible-list/collapsible-list.md

-@## Separators
+@## CSS
+
+### Separators


@### Separators - it's not a full-fledged CSS API section (cuz the component is React only) but rather a usage note

packages/core/src/components/editable-text/editable-text.md

@@ -62,3 +56,5 @@ _vertically_ instead, based on the number of lines of text. You can use the `min
    which would provide a sub-optimal experience for users (multiline text does not always render
    cleanly into a single line).
 </div>
+
+@interface IEditableTextProps


blueprint-bot · 2018-06-06T22:58:19Z

menu docs

Preview: documentation | landing | table

giladgray · 2018-06-07T19:32:23Z

packages/core/src/components/navbar/navbar.md

+@interface INavbarHeadingProps
+
+@interface INavbarDividerProps
+
 @## CSS API


blueprint-bot · 2018-06-07T22:18:59Z

context menu docs

Preview: documentation | landing | table

blueprint-bot · 2018-06-13T21:09:51Z

all Overlays polish

Preview: documentation | landing | table

* button CSS text refactors * fix button group alignment support * simplify BG CSS example, fill modifier sets full width/height based on vertical * refactor BG docs & examples * more edits

blueprint-bot · 2018-06-13T21:15:20Z

singular component page titles

Preview: documentation | landing | table

blueprint-bot · 2018-06-13T21:15:32Z

[docs] improve button-group docs (#2594)

Preview: documentation | landing | table

benjdj6 · 2018-06-15T21:36:40Z

packages/core/src/components/context-menu/context-menu.md


-Context menus present the user with a custom list of actions upon right-click.
+Context menus present the user with a list of actions upon right-click.


"...a right-click."

packages/core/src/components/context-menu/context-menu.md

  to a React component that implements `renderContextMenu(): JSX.Element`.
- via the [imperative](#core/components/context-menu.imperative-api) `ContextMenu.show`
+1. Use the [imperative](#core/components/context-menu.imperative-api) `ContextMenu.show`


benjdj6 · 2018-06-15T21:39:34Z

packages/core/src/components/context-menu/context-menu.md

+  Show the given element at the given offset from the top-left corner of the
+  viewport. Showing a menu closes the previously shown one automatically. The
+  menu appears below-right of this point, but will flip to below-left instead if
+  there is not enough room onscreen. The optional callback is invoked when this


benjdj6 · 2018-06-15T21:43:11Z

packages/core/src/components/editable-text/editable-text.md

 ```

-Provide the `multiline` prop to create an `EditableText` field that spans multiple lines. Multiline
-mode uses a `<textarea>` instead of an `<input type="text">` to support multiple lines of text.
+Users confirm text in multiline mode by pressing `ctrl` `enter` or `cmd` `enter`


"+" between the key names.

benjdj6 · 2018-06-15T21:43:57Z

packages/core/src/components/editable-text/editable-text.md

-    cleanly into a single line).
-</div>
+The `onConfirm` and `onCancel` callbacks are invoked based on user interaction.
+The user presses `enter` (or `cmd` `enter` when multiline) or blurs the input to


"+" between key names

benjdj6 · 2018-06-15T23:58:06Z

packages/core/src/components/popover/popover.md

-`@ns-popover-dismiss` to that element. For example, the "Dismiss" button in the top-level [Popover example](#core/components/popover) has this class. To enable this behavior on the entire popover, pass the
-`popoverClassName="@ns-popover-dismiss"` prop.
+To enable click-to-close behavior on an element inside a popover, simply add the
+class `Classes.POPOVER_DISMISS` to that element. For example, the "Dismiss"


Dismiss should be bold as it's an interactive UI element.

packages/core/src/components/portal/portal.md

-    apply `position: absolute` to the `<body>` tag.
-</div>
+1. `Portal` `children` are wrapped in an extra `<div>` inside the portal container element.
+1. Test harnesses such as `enzyme` cannot trivially find elements "through" Portals as they're not in the same React tree.


benjdj6 · 2018-06-15T23:59:09Z

packages/core/src/components/portal/portal.md

-</div>
+1. `Portal` `children` are wrapped in an extra `<div>` inside the portal container element.
+1. Test harnesses such as `enzyme` cannot trivially find elements "through" Portals as they're not in the same React tree.
+1. React `context` _is_ preserved (this one's a good thing).


This should be a 3.

markdown lists tho. keeping them all the same number is more maintainable for future edits

Forgot that markdown was forgiving about this (used to rst).

benjdj6 · 2018-06-16T00:05:17Z

packages/core/src/components/tag/tag.md

-Blueprint class name.
-
-@interface ITagProps
+Create a tag with a `span.@ns-tag`. An optional "remove" button can be added


Bold remove as it is an interactive UI element.

the element doesn't actually say "remove", it's just an ✖️ . does it still need bold?

It does not.

* refactor datetime docs * timezone docs

blueprint-bot · 2018-06-18T18:10:22Z

[docs] refactor datetime docs to focus on React usage (#2596)

Preview: documentation | landing | table

* ControlGroup & FormGroup * merge all text input docs into one file * singular titles * text area props * edits

…rewrite

blueprint-bot · 2018-06-18T18:15:22Z

[docs] refactor forms docs (#2600)

Preview: documentation | landing | table

blueprint-bot · 2018-06-18T18:18:06Z

edits

Preview: documentation | landing | table

blueprint-bot · 2018-06-18T19:03:56Z

resolve forms nav: Form controls & Form inputs sections

Preview: documentation | landing | table

Gilad Gray and others added 12 commits June 3, 2018 12:22

Button: collapse css examples

84b24ed

Callout + intent docs

88d7eef

Progress bar

7c84f9b

Skeleton, Spinner , Table

a97ed98

add new buttons example

ade11f7

breadcrumbs docs

81ae9ad

button groups docs

e32f5a3

card docs

56bdc97

collapse docs

c7eae76

collapsible list docs

c10b97d

editable text docs

8895038

more collapsible list

9d3c39a

giladgray commented Jun 6, 2018

View reviewed changes

Antoine Llorca added 7 commits June 6, 2018 14:33

more card

ae43f5e

remove button group code block

7e378a7

comments

efb12d7

navbar docs

42f4698

hotkeys docs

485f01d

icon docs

f0fcefb

menu docs

3a45a6b

giladgray requested a review from llorca June 7, 2018 18:34

giladgray commented Jun 7, 2018

View reviewed changes

Antoine Llorca added 3 commits June 7, 2018 15:14

alert docs

54b08e9

fix collapsible separators

250e96f

context menu docs

62a1a74

Antoine Llorca added 3 commits June 7, 2018 15:27

dialog docs

b81708a

editable text fixes

6b543e4

label docs

ad47dc0

Gilad Gray added 4 commits June 13, 2018 13:22

Progress Bar, Table HTML, Tag, Tree polish

e973f94

Spinner polish (remove CSS)

7445031

Tabs polish

31577f2

all Overlays polish

e604814

giladgray mentioned this pull request Jun 13, 2018

[WiP] refactor docs to focus on React usage #2471

Closed

giladgray added Domain: documentation Type: refactor labels Jun 13, 2018

Gilad Gray and others added 2 commits June 13, 2018 14:10

singular component page titles

e346900

[docs] improve button-group docs (#2594)

c930adb

* button CSS text refactors * fix button group alignment support * simplify BG CSS example, fill modifier sets full width/height based on vertical * refactor BG docs & examples * more edits

This was referenced Jun 13, 2018

[docs] refactor datetime docs to focus on React usage #2596

Merged

[docs] refactor forms docs #2600

Merged

benjdj6 reviewed Jun 16, 2018

View reviewed changes

[docs] refactor datetime docs to focus on React usage (#2596)

ff3686e

* refactor datetime docs * timezone docs

giladgray and others added 3 commits June 18, 2018 11:11

[docs] refactor forms docs (#2600)

9a72afd

* ControlGroup & FormGroup * merge all text input docs into one file * singular titles * text area props * edits

Merge branch 'develop' of github.com:palantir/blueprint into gg/docs-…

49efb7e

…rewrite

edits

52e4f3c

Gilad Gray added 4 commits June 18, 2018 11:30

tag-input add note about newlines, wrap lines

4b89911

FileInput docs

156b9b8

checkbox etc docs

2912c95

resolve forms nav: Form controls & Form inputs sections

094af73

giladgray merged commit efe5bfc into develop Jun 18, 2018

giladgray deleted the gg/docs-rewrite branch June 18, 2018 21:02

giladgray mentioned this pull request Jul 10, 2018

[Button] fix dark & minimal #2670

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] refactor content to focus on React usage #2574

[docs] refactor content to focus on React usage #2574

giladgray commented Jun 6, 2018 •

edited

Loading

giladgray Jun 6, 2018

giladgray Jun 6, 2018

giladgray Jun 6, 2018

giladgray Jun 6, 2018

giladgray Jun 6, 2018

giladgray Jun 6, 2018

giladgray Jun 6, 2018

This comment was marked as resolved.

blueprint-bot commented Jun 6, 2018

giladgray Jun 7, 2018

blueprint-bot commented Jun 7, 2018

blueprint-bot commented Jun 13, 2018

blueprint-bot commented Jun 13, 2018

blueprint-bot commented Jun 13, 2018

benjdj6 Jun 15, 2018

This comment was marked as resolved.

benjdj6 Jun 15, 2018

benjdj6 Jun 15, 2018

benjdj6 Jun 15, 2018

benjdj6 Jun 15, 2018

This comment was marked as resolved.

benjdj6 Jun 15, 2018

giladgray Jun 16, 2018

benjdj6 Jun 18, 2018

benjdj6 Jun 16, 2018

giladgray Jun 16, 2018

benjdj6 Jun 18, 2018

blueprint-bot commented Jun 18, 2018

blueprint-bot commented Jun 18, 2018

blueprint-bot commented Jun 18, 2018

blueprint-bot commented Jun 18, 2018

		@@ -21,24 +39,3 @@ changes to a pointer and increases the elevation shadow on the card.
		Users expect an interactive card to be a single clickable unit.

		@css card-interactive


		Context menus present the user with a custom list of actions upon right-click.
		Context menus present the user with a list of actions upon right-click.

[docs] refactor content to focus on React usage #2574

[docs] refactor content to focus on React usage #2574

Conversation

giladgray commented Jun 6, 2018 • edited Loading

Fixes #2465, Fixes #2542

Changes proposed in this pull request:

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

Choose a reason for hiding this comment

This comment was marked as resolved.

blueprint-bot commented Jun 6, 2018

menu docs

Choose a reason for hiding this comment

blueprint-bot commented Jun 7, 2018

context menu docs

blueprint-bot commented Jun 13, 2018

all Overlays polish

blueprint-bot commented Jun 13, 2018

singular component page titles

blueprint-bot commented Jun 13, 2018

[docs] improve button-group docs (#2594)

Choose a reason for hiding this comment

This comment was marked as resolved.

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

This comment was marked as resolved.

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

blueprint-bot commented Jun 18, 2018

[docs] refactor datetime docs to focus on React usage (#2596)

blueprint-bot commented Jun 18, 2018

[docs] refactor forms docs (#2600)

blueprint-bot commented Jun 18, 2018

edits

blueprint-bot commented Jun 18, 2018

resolve forms nav: Form controls & Form inputs sections

giladgray commented Jun 6, 2018 •

edited

Loading