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

Documentation #928

Merged
merged 33 commits into from
Apr 3, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
b06577f
markdownify docs (#714)
giladgray Mar 1, 2017
9a6d585
[DM] forms docs nesting fixes (#755)
giladgray Mar 2, 2017
85d8b51
Merge branch 'master' of github.com:palantir/blueprint into feature/d…
Mar 2, 2017
1ca4c0d
add tsx syntax hints to code blocks
Mar 2, 2017
cce4dfe
[DM] Documentalist! (#756)
giladgray Mar 7, 2017
97e7c4b
fix duplicate typography.dark-theme key warning
Mar 7, 2017
f495189
Merge branch 'master' of github.com:palantir/blueprint into feature/d…
Mar 7, 2017
32a1b60
Tabs2 docs in new page
Mar 7, 2017
9c91ada
write components.md
Mar 7, 2017
878bc35
nav only shows heading links when on that page
Mar 7, 2017
d9f213c
only scroll nav menu if active item is not visible
Mar 7, 2017
0f0c93c
fix hotkey headings depth
Mar 7, 2017
fd52178
:bug: only scroll to heading when page changes
Mar 7, 2017
4f59c96
delete KSS docs from common/ files
Mar 9, 2017
10b1c2c
restore Progress pages (bar/spinner/skeleton)
Mar 9, 2017
8be6651
fix slider duplicate key warning with new range-slider page
Mar 9, 2017
5618c9d
delete _tabs2.scss (docs only) and fix one code sample
Mar 9, 2017
776548b
[DM] KSS for CSS examples (#813)
giladgray Mar 15, 2017
bcce1c5
[DM] docs for all packages (#818)
giladgray Mar 15, 2017
4d16cd5
only update scroll position when page changes (#840)
giladgray Mar 15, 2017
d253ec5
[DM] update documentalist for syntax highlighting (#846)
giladgray Mar 15, 2017
1022e03
[DM] React examples styles (#839)
giladgray Mar 16, 2017
b5fd8e6
Merge branch 'master' of github.com:palantir/blueprint into feature/d…
Mar 16, 2017
365c520
[DM] rename .kss-* → .docs-* (#850)
giladgray Mar 16, 2017
f98300e
[DM] squash some pages (#883)
giladgray Mar 28, 2017
9deb01c
[DM] core/components/button.javascript-api (#882)
giladgray Mar 28, 2017
f764510
[DM] nav nesting (#899)
giladgray Mar 28, 2017
3290f79
Documentation Overhaul (#917)
themadcreator Mar 31, 2017
260de5a
Merge branch 'master' of github.com:palantir/blueprint into feature/d…
Mar 31, 2017
d1d9ae0
[DM] update docs files and links (#927)
giladgray Mar 31, 2017
3eba449
Fix text example tag
themadcreator Mar 31, 2017
4b4217f
Fix text navbar issue
themadcreator Mar 31, 2017
c9b1e66
Fix tree example styles
themadcreator Apr 3, 2017
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
restore Progress pages (bar/spinner/skeleton)
decided simplest approach was a mostly empty root `progress` page
that links to the other three.
  • Loading branch information
Gilad Gray committed Mar 9, 2017
commit 10b1c2c64571ea4cc9d56cf8829330a2e4a992ab
2 changes: 1 addition & 1 deletion packages/core/src/components/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Check out the [React API docs](https://facebook.github.io/react/docs/react-api.h
@page overlay
@page popover
@page portal
<!--@page progress-bar-->
@page progress
@page slider
@page table
@page tabs
Expand Down
10 changes: 3 additions & 7 deletions packages/core/src/components/progress/progress-bar.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
@# Progress

Blueprint provides two ways to indicate progress: a horizontal progress bar and a circular spinner.

@## Progress bars
@# Progress bars

Progress bars can indicate determinate progress towards the completion of a task or an indeterminate
loading state.

@### CSS API
@## CSS API

Set the current progress of the bar via a `width` style rule on the inner `.pt-progress-meter`
element. This is a very simple CSS-only component, and input validation for `width` values is
limited: values above `100%` appear as 100% progress and values below `0%` appear as 0%.

Omitting `width` will result in an "indeterminate" progress meter that fills the entire bar.

@### JavaScript API
@## JavaScript API

The `ProgressBar` component is available in the __@blueprintjs/core__ package.
Make sure to review the [general usage docs for JS components](#components.usage).
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/components/progress/progress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@# Progress

Blueprint provides two ways to indicate progress: a horizontal progress bar and a circular spinner.

@page progress-bar
@page spinner
@page skeleton
4 changes: 2 additions & 2 deletions packages/core/src/components/skeleton/skeleton.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
@## Skeletons
@# Skeletons

Skeletons allow you to show a loading state that mimics the shape of your yet-to-load content.

@### CSS API
@## CSS API

Apply the class `.pt-skeleton` to elements that you would like to cover up with a loading animation.
The skeleton inherits the dimensions of whatever element the class is applied to. This means that
Expand Down
8 changes: 4 additions & 4 deletions packages/core/src/components/spinner/spinner.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
@## Spinners
@# Spinners

Spinners indicate indeterminate progress.

@### CSS API
@## CSS API

You can create spinners manually by inserting their whole markup into your HTML.
Spinners created via markup use same modifier classes as the
[React `Spinner` component](#components.progress.spinner.js).

@### JavaScript API
@## JavaScript API

The `Spinner` component is available in the __@blueprintjs/core__ package.
Make sure to review the [general usage docs for JS components](#components.usage).
Expand All @@ -35,7 +35,7 @@ are supported via the `className` prop.

[msdn-css-svg]: https://developer.microsoft.com/en-us/microsoft-edge/platform/status/csstransitionsforsvgelements/?q=svg

@#### SVG spinner
@### SVG spinner

Use the `SVGSpinner` component to render a spinner inside an SVG element.

Expand Down