Skip to content

Commit

Permalink
docs: update component docs for new packaging (#1375)
Browse files Browse the repository at this point in the history
  • Loading branch information
ianjoneill authored and jelbourn committed Oct 5, 2016
1 parent 37a8c4d commit b91e983
Show file tree
Hide file tree
Showing 8 changed files with 1 addition and 94 deletions.
11 changes: 0 additions & 11 deletions src/lib/button-toggle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,6 @@ You can read more about button toggles in the

## Usage

### Setup

Importing the module:
```ts
@NgModule({
imports: [MdButtonToggleModule.forRoot()],
...
})
export class MyAppModule { }
```

### Basic Usage

`md-button-toggle` can be used on its own and acts as a checkbox.
Expand Down
3 changes: 1 addition & 2 deletions src/lib/core/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
Core library code for other `@angular2-material` components.
This should be added as a dependency for any project using the components.
Core library code for other `@angular/material` components.
13 changes: 0 additions & 13 deletions src/lib/grid-list/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,6 @@ See Material Design spec [here](https://www.google.com/design/spec/components/gr

### Simple grid list

To use `md-grid-list`, import the MdGridList module into your application's NgModule:

*my-app-module.ts*
```ts
import {MdGridListModule} from '@angular2-material/grid-list';

@NgModule({
imports: [MdGridListModule.forRoot()],
...
})
export class MyAppModule {}
```

In your template, create an `md-grid-list` element and specify the number of columns you want for
your grid using the `cols` property (this is the only mandatory attribute).

Expand Down
13 changes: 0 additions & 13 deletions src/lib/list/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,6 @@

### Simple list

To use `md-list`, import the MdList module into your application's NgModule:

*my-app-module.ts*
```ts
import {MdListModule} from '@angular2-material/list';

@NgModule({
imports: [MdListModule.forRoot()],
...
})
export class MyAppModule {}
```

In your template, create an `md-list` element and wrap each of your items in an `md-list-item` tag.

```html
Expand Down
21 changes: 0 additions & 21 deletions src/lib/menu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,6 @@

## Usage

### Setup

Import the MdMenu module.

*my-app-module.ts*
```ts
import {MdMenuModule} from '@angular2-material/menu';

@NgModule({
imports: [MdMenuModule.forRoot()],
...
})
export class MyAppModule {}
```

For alpha.7, you need to include the overlay styles in your app via a `link` element. This will
look something like
```html
<link href="vendor/@angular2-material/core/overlay/overlay.css" rel="stylesheet">
```

### Simple menu

In your template, create an `md-menu` element. You can use either `<button>` or `<anchor>` tags for
Expand Down
15 changes: 0 additions & 15 deletions src/lib/radio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,6 @@ Radio buttons allow the user to select one option from a set. Use radio buttons

![Preview](https://material.angularjs.org/material2_assets/radio/radios.png)

### Setup
Importing the symbols:
```ts
import { MdRadioModule } from '@angular2-material/radio';
```

Adding providers and directives:
```ts
@NgModule({
imports: [MdRadioModule.forRoot()],
...
})
export class MyAppModule { }
```

### Examples
A basic radio group would have the following markup.
```html
Expand Down
11 changes: 0 additions & 11 deletions src/lib/slider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,6 @@ You can read more about the slider in the

## Usage

### Setup

Importing the module:
```ts
@NgModule({
imports: [MdSliderModule.forRoot()],
...
})
export class MyAppModule { }
```

### Basic Usage

`md-slider` can be used on its own as a slider with a min of `0`, a max of `100`, and a step of `1`.
Expand Down
8 changes: 0 additions & 8 deletions src/lib/tooltip/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# MdTooltip
Tooltip allows the user to specify text to be displayed when the mouse hover over an element.

### Setup
For alpha.7, you need to include the overlay styles in your app via a `link` element. This will
look something like
```html
<link href="vendor/@angular2-material/core/overlay/overlay.css" rel="stylesheet">
```


### Examples
A button with a tooltip
```html
Expand Down

0 comments on commit b91e983

Please sign in to comment.