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-app] create "Design Principles" section, mention CSS API contract #3678

Merged
merged 1 commit into from
Jul 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 5 additions & 11 deletions packages/docs-app/src/blueprint.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Blueprint v3 is available now! [See what's new.](#blueprint/whats-new-3.0)

### Install

**@blueprintjs/core** is the primary Blueprint package on NPM and home to over 40 components.
**@blueprintjs/core** is the primary Blueprint package on NPM and home to over 40 components. Install it with your package manager ([Yarn](https://yarnpkg.com/) is used in this example):

```sh
yarn add @blueprintjs/core react react-dom
Expand All @@ -36,26 +36,20 @@ import { Button } from "@blueprintjs/core";
<Button intent="success" text="button content" onClick={incrementCounter} />
```

Don't forget to include the **main CSS file** from each Blueprint package!
For this button to be styled correctly in the DOM, it needs its associated CSS to be loaded on the page.
Don't forget to include the **main CSS file** from each Blueprint package and their dependencies!
The following example shows an `index.html` file; the same stylesheets should be loaded if you use a bundler like Webpack.

```html
<!-- in index.html, or however you manage your CSS files -->
<link href="path/to/node_modules/normalize.css/normalize.css" rel="stylesheet" />
<!-- blueprint-icons.css file must be included alongside blueprint.css! -->
<link href="path/to/node_modules/@blueprintjs/icons/lib/css/blueprint-icons.css" rel="stylesheet" />
<link href="path/to/node_modules/@blueprintjs/core/lib/css/blueprint.css" rel="stylesheet" />
<!-- add other blueprint-*.css files here -->
```

@## Browser support

**Blueprint supports Chrome, Firefox, Safari, IE 11, and Microsoft Edge.**

You may experience degraded visuals in IE.
IE 10 and below are unsupported due to their lack of support for CSS Flexbox Layout.
These browsers were deprecated by Microsoft (end of support) in [January 2016](https://www.microsoft.com/en-us/WindowsForBusiness/End-of-IE-support).

@page getting-started
@page reading-the-docs
@page principles
@page whats-new-2.0
@page whats-new-3.0
17 changes: 17 additions & 0 deletions packages/docs-app/src/principles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
@# Design Principles

@## Browser support

**Blueprint supports Chrome, Firefox, Safari, IE 11, and Microsoft Edge.**

You may experience degraded visuals in IE.
IE 10 and below are unsupported due to their lack of support for CSS Flexbox Layout.
These browsers were deprecated by Microsoft (end of support) in [January 2016](https://www.microsoft.com/en-us/WindowsForBusiness/End-of-IE-support).

@## API Contract

Blueprint strictly adheres to [semver](https://semver.org/) in its public APIs:

- JS APIs exported from the root/main module of a Blueprint package
- HTML structure of components
- CSS styles for rendered components