Skip to content
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.

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

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

Merged
merged 68 commits into from
Jun 18, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
68 commits
Select commit Hold shift + click to select a range
84b24ed
Button: collapse css examples
Jun 3, 2018
88d7eef
Callout + intent docs
Jun 3, 2018
7c84f9b
Progress bar
Jun 3, 2018
a97ed98
Skeleton, Spinner , Table
Jun 3, 2018
ade11f7
add new buttons example
Jun 3, 2018
81ae9ad
breadcrumbs docs
Jun 6, 2018
e32f5a3
button groups docs
Jun 6, 2018
56bdc97
card docs
Jun 6, 2018
c7eae76
collapse docs
Jun 6, 2018
c10b97d
collapsible list docs
Jun 6, 2018
8895038
editable text docs
Jun 6, 2018
9d3c39a
more collapsible list
Jun 6, 2018
ae43f5e
more card
Jun 6, 2018
7e378a7
remove button group code block
Jun 6, 2018
efb12d7
comments
Jun 6, 2018
42f4698
navbar docs
Jun 6, 2018
485f01d
hotkeys docs
Jun 6, 2018
f0fcefb
icon docs
Jun 6, 2018
3a45a6b
menu docs
Jun 6, 2018
54b08e9
alert docs
Jun 7, 2018
250e96f
fix collapsible separators
Jun 7, 2018
62a1a74
context menu docs
Jun 7, 2018
b81708a
dialog docs
Jun 7, 2018
6b543e4
editable text fixes
Jun 7, 2018
ad47dc0
label docs
Jun 7, 2018
5c9a9b2
navbar docs
Jun 7, 2018
291fc00
non ideal state docs
Jun 7, 2018
d343b19
add props heading to overflow list
Jun 7, 2018
3d9bde3
overlay docs
Jun 7, 2018
a783fff
popover docs
Jun 7, 2018
de75a53
portal docs
Jun 7, 2018
5110042
tabs docs
Jun 7, 2018
24048ec
tag docs
Jun 7, 2018
7cbe942
text docs
Jun 7, 2018
cfd897a
toast docs
Jun 7, 2018
4674b0f
tooltip docs
Jun 7, 2018
150ff2a
tree docs
Jun 7, 2018
a7149f7
context menu usage
Jun 7, 2018
d2864dc
wrong tick
Jun 7, 2018
010deea
CSS -> Style
Jun 7, 2018
9eee697
move portal props down
Jun 8, 2018
d7a2ea9
tabs props
Jun 8, 2018
8fc3962
text update
Jun 8, 2018
700573a
merge minimal tag CSS docs
Jun 8, 2018
4e2cf4a
Merge branch 'develop' into gg/docs-rewrite
giladgray Jun 8, 2018
e53a8c1
Merge branch 'develop' of github.com:palantir/blueprint into gg/docs-…
Jun 13, 2018
bf7ab8b
card polish
Jun 13, 2018
2e30276
CollapsibleList polish
Jun 13, 2018
350495b
EditableText polish
Jun 13, 2018
433bd8a
Icon polish
Jun 13, 2018
19323a1
Menu polish
Jun 13, 2018
7a441ca
Spinner polish
Jun 13, 2018
5f97289
Navbar polish
Jun 13, 2018
f638e8c
NIS polish
Jun 13, 2018
e973f94
Progress Bar, Table HTML, Tag, Tree polish
Jun 13, 2018
7445031
Spinner polish (remove CSS)
Jun 13, 2018
31577f2
Tabs polish
Jun 13, 2018
e604814
all Overlays polish
Jun 13, 2018
e346900
singular component page titles
Jun 13, 2018
c930adb
[docs] improve button-group docs (#2594)
giladgray Jun 13, 2018
ff3686e
[docs] refactor datetime docs to focus on React usage (#2596)
giladgray Jun 18, 2018
9a72afd
[docs] refactor forms docs (#2600)
giladgray Jun 18, 2018
49efb7e
Merge branch 'develop' of github.com:palantir/blueprint into gg/docs-…
Jun 18, 2018
52e4f3c
edits
Jun 18, 2018
4b89911
tag-input add note about newlines, wrap lines
Jun 18, 2018
156b9b8
FileInput docs
Jun 18, 2018
2912c95
checkbox etc docs
Jun 18, 2018
094af73
resolve forms nav: Form controls & Form inputs sections
Jun 18, 2018
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
Prev Previous commit
Next Next commit
Progress Bar, Table HTML, Tag, Tree polish
  • Loading branch information
Gilad Gray committed Jun 13, 2018
commit e973f947ce4a4ab9b700625f989f22504c898464
8 changes: 4 additions & 4 deletions packages/core/src/components/progress-bar/progress-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
Progress bars indicate progress towards the completion of a task or an
indeterminate loading state.

@reactExample ProgressExample

@## Props

`ProgressBar` is a simple stateless component that renders the appropriate HTML
markup. It supports a `value` prop between 0 and 1 that determines the width of
the progress meter. Omitting `value` will result in an "indeterminate" progress
meter that fills the entire bar.

@reactExample ProgressExample

@## Props

@interface IProgressBarProps

@## CSS
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/components/table/table-html.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
@# Tables (HTML)

This component adds Blueprint styling to native HTML tables.
This component provides Blueprint styling to native HTML tables.

<div class="@ns-callout @ns-intent-primary @ns-icon-info-sign">
<h4 class="@ns-heading">This is not @blueprintjs/table</h4>
Expand Down
16 changes: 5 additions & 11 deletions packages/core/src/components/tag/tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,15 @@ Tags are great for lists of strings.

@## Props

The `Tag` component is available in the __@blueprintjs/core__ package.
Make sure to review the [getting started docs for installation info](#blueprint/getting-started).

Tag components render `.@ns-tag` elements with optional close buttons. Provide tag content as `children`.

You can provide your own props to these components as if they were regular JSX HTML elements. If
you provide a `className` prop, the class names you provide will be added alongside of the default
Blueprint class name.
`Tag` is a stateless wrapper around its children with support for an optional
close button. It also supports all HTML `<span>` props.

@interface ITagProps

@## CSS

An optional "remove" button can be added inside a tag with a
`button.@ns-tag-remove` as the last child. The button is a separate element to
support interaction handlers in your framework of choice.
Create a tag with a `span.@ns-tag`. An optional "remove" button can be added
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bold remove as it is an interactive UI element.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not.

with a `button.@ns-tag-remove` as the last child. The button is a separate
element to support interaction handlers in your framework of choice.

@css tag
4 changes: 2 additions & 2 deletions packages/core/src/components/tag/tag.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { Text } from "../text/text";

export interface ITagProps extends IProps, IIntentProps, React.HTMLAttributes<HTMLSpanElement> {
/**
* If set to `true`, the tag will display in an active state.
* Whether the tag should appear in an active state.
* @default false
*/
active?: boolean;
Expand Down Expand Up @@ -60,7 +60,7 @@ export interface ITagProps extends IProps, IIntentProps, React.HTMLAttributes<HT

/**
* Click handler for remove button.
* Button will only be rendered if this prop is defined.
* The remove button will only be rendered if this prop is defined.
*/
onRemove?: (e: React.MouseEvent<HTMLButtonElement>, tagProps: ITagProps) => void;

Expand Down
6 changes: 2 additions & 4 deletions packages/core/src/components/tree/tree.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Trees display hierarchical data.
@## Props

`Tree` is a stateless component. Its contents are dictated by the `contents` prop, which is an array
of `ITreeNode`s (see [below](#components/tree.tree-node-interface)). The tree is multi-rooted if
of `ITreeNode`s (see [below](#components/tree.tree-node)). The tree is multi-rooted if
`contents` contains more than one top-level object.

A variety of interaction callbacks are also exposed as props. All interaction callbacks supply a
Expand All @@ -18,9 +18,7 @@ example, `[2, 0]` represents the first child (`0`) of the third top-level node (

@### Instance methods

<div class="@ns-monospace-text">Tree</div>

* `getNodeContentElement(nodeId: string | number): HTMLElement | undefined` &ndash;
* `Tree.getNodeContentElement(nodeId: string | number): HTMLElement | undefined` &ndash;
Returns the underlying HTML element of the `Tree` node with an id of `nodeId`.
This element does not contain the children of the node, only its label and controls.
If the node is not currently mounted, `undefined` is returned.
Expand Down