docs: add temporary docs for cdk #5429

jelbourn · 2017-06-30T01:56:31Z

Update getting started guide WRT cdk
Add some temporary docs for cdk to be viewed on Github until we can integrate them into material.angular.io
Small change to docs generation to output ck docs (but not do anything with them yet)

mmalerba · 2017-06-30T16:23:07Z

guides/getting-started.md

 ```

-Note that your app's project structure may have a different relative location for your node_modules.
+If you are not using the Angular CLI, you can include a prebuilt theme via a `<link>` element in
+your `index.html`.


can we add back the example for this? or are you afraid people won't read and will just add both?

There's no one path to node_modules that would work for everyone, and if we put anything there then people copy it and complain that it doesn't work.

mmalerba · 2017-06-30T16:25:23Z

src/cdk/a11y/focus-trap.md

@@ -0,0 +1,12 @@
+### FocusTrap
+The `cdkFocusTrap` directive traps Tab key focus within an element. This is intended to be used to


cdkTrapFocus

mmalerba · 2017-06-30T16:25:35Z

src/cdk/a11y/focus-trap.md

+
+#### Example
+```
+<div class="my-inner-dialog-content" cdkFocusTrap>


cdkTrapFocus

mmalerba · 2017-06-30T16:27:17Z

src/cdk/a11y/list-key-manager.md

+The active item
+
+#### `tabOut`
+Observable that emits any time the TAB key is pressed, so components can react when focus is


nit: in the other files TAB is capitalized like this: Tab

mmalerba · 2017-06-30T16:29:28Z

src/cdk/bidi/bidi.md

@@ -0,0 +1,21 @@
+ ### BidiModule


remove leading space

mmalerba · 2017-06-30T16:30:13Z

src/cdk/portal/portal.md

-### Using portals
-
-
+### Portals in practice


did you mean to use same heading level as main heading?

kara

LGTM, just nits. Also, should we remove the merge-safe label? It has code changes to list-key-manager.

kara · 2017-06-30T16:31:25Z

src/cdk/a11y/focus-trap.md

@@ -0,0 +1,12 @@
+### FocusTrap
+The `cdkFocusTrap` directive traps Tab key focus within an element. This is intended to be used to


Nit: Use <kbd> for Tab or lowercase it?

kara · 2017-06-30T16:33:28Z

src/cdk/a11y/focus-trap.md

@@ -0,0 +1,12 @@
+### FocusTrap
+The `cdkFocusTrap` directive traps Tab key focus within an element. This is intended to be used to
+create components like [modal dialogs](https://www.w3.org/TR/wai-aria-practices-1.1/#dialog_modal).


For clarity, maybe we should say intended to be used to make components like modal dialogs more accessible.... Think it could be confusing to say it's used to create them, since it's not a building tool.

Clarified as "This is intended to be used to create accessible experience for components like..."

kara · 2017-06-30T16:33:53Z

src/cdk/a11y/focus-trap.md

+This directive is declared in `A11yModule`.
+
+#### Example
+```


Add html notation to get syntax highlighting?

kara · 2017-06-30T16:37:18Z

src/cdk/a11y/live-announcer.md

+`aria-live` attribute on the announcer element, defaulting to 'polite'.
+
+#### Examples
+The LiveAnnouncer is injected in a component:


Nit: in a component -> into a component

jelbourn

Addressed comments

jelbourn · 2017-06-30T16:49:29Z

guides/getting-started.md

 ```

-Note that your app's project structure may have a different relative location for your node_modules.
+If you are not using the Angular CLI, you can include a prebuilt theme via a `<link>` element in
+your `index.html`.


There's no one path to node_modules that would work for everyone, and if we put anything there then people copy it and complain that it doesn't work.

jelbourn · 2017-06-30T16:50:25Z

src/cdk/a11y/focus-trap.md

@@ -0,0 +1,12 @@
+### FocusTrap
+The `cdkFocusTrap` directive traps Tab key focus within an element. This is intended to be used to


jelbourn · 2017-06-30T16:50:29Z

src/cdk/a11y/focus-trap.md

@@ -0,0 +1,12 @@
+### FocusTrap
+The `cdkFocusTrap` directive traps Tab key focus within an element. This is intended to be used to


jelbourn · 2017-06-30T16:51:33Z

src/cdk/a11y/focus-trap.md

@@ -0,0 +1,12 @@
+### FocusTrap
+The `cdkFocusTrap` directive traps Tab key focus within an element. This is intended to be used to
+create components like [modal dialogs](https://www.w3.org/TR/wai-aria-practices-1.1/#dialog_modal).


Clarified as "This is intended to be used to create accessible experience for components like..."

jelbourn · 2017-06-30T16:51:45Z

src/cdk/a11y/focus-trap.md

+This directive is declared in `A11yModule`.
+
+#### Example
+```


jelbourn · 2017-06-30T16:52:00Z

src/cdk/a11y/focus-trap.md

+
+#### Example
+```
+<div class="my-inner-dialog-content" cdkFocusTrap>


jelbourn · 2017-06-30T16:52:31Z

src/cdk/a11y/list-key-manager.md

+The active item
+
+#### `tabOut`
+Observable that emits any time the TAB key is pressed, so components can react when focus is


jelbourn · 2017-06-30T16:52:49Z

src/cdk/a11y/live-announcer.md

+`aria-live` attribute on the announcer element, defaulting to 'polite'.
+
+#### Examples
+The LiveAnnouncer is injected in a component:


jelbourn · 2017-06-30T16:53:03Z

src/cdk/bidi/bidi.md

@@ -0,0 +1,21 @@
+ ### BidiModule


jelbourn · 2017-06-30T16:53:48Z

src/cdk/portal/portal.md

-### Using portals
-
-
+### Portals in practice


* With angular#5429 dgeni runs twice when running the `gulp docs` command. This is because the dgeni generate function has been added to the `dgeni/index.js` file.

* With #5429 dgeni runs twice when running the `gulp docs` command. This is because the dgeni generate function has been added to the `dgeni/index.js` file.

* With angular#5429 dgeni runs twice when running the `gulp docs` command. This is because the dgeni generate function has been added to the `dgeni/index.js` file.

angular-automatic-lock-bot · 2019-09-08T14:02:34Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

jelbourn added docs This issue is related to documentation pr: needs review labels Jun 30, 2017

jelbourn requested review from kara and mmalerba June 30, 2017 01:56

googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Jun 30, 2017

mmalerba reviewed Jun 30, 2017

View reviewed changes

jelbourn added the pr: merge safe label Jun 30, 2017

kara approved these changes Jun 30, 2017

View reviewed changes

kara added pr: lgtm and removed pr: needs review labels Jun 30, 2017

kara assigned jelbourn Jun 30, 2017

docs: add temporary docs for cdk

7705c12

jelbourn force-pushed the cdk-docsss branch from 7079f38 to 7705c12 Compare June 30, 2017 16:54

jelbourn commented Jun 30, 2017

View reviewed changes

mmalerba approved these changes Jun 30, 2017

View reviewed changes

mmalerba merged commit 4562407 into angular:master Jul 5, 2017

devversion mentioned this pull request Jul 6, 2017

build: dgeni is building docs twice #5536

Merged

mmalerba pushed a commit that referenced this pull request Jul 6, 2017

build: dgeni is building docs twice (#5536)

e3f3233

* With #5429 dgeni runs twice when running the `gulp docs` command. This is because the dgeni generate function has been added to the `dgeni/index.js` file.

amcdnl pushed a commit to amcdnl/material2 that referenced this pull request Jul 8, 2017

docs: add temporary docs for cdk (angular#5429)

c9ac5e5

jelbourn deleted the cdk-docsss branch April 2, 2018 22:30

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 8, 2019

		@@ -0,0 +1,12 @@
		### FocusTrap
		The `cdkFocusTrap` directive traps Tab key focus within an element. This is intended to be used to

docs: add temporary docs for cdk #5429

docs: add temporary docs for cdk #5429

Uh oh!

Conversation

jelbourn commented Jun 30, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kara left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jelbourn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

angular-automatic-lock-bot bot commented Sep 8, 2019

Uh oh!

Uh oh!

kara left a comment •

edited

Loading