General documentation fixes (link to parent: CanJS#4116, Component#264, and Component#270) by michaelzcheng · Pull Request #288 · canjs/can-component

michaelzcheng · 2018-07-25T18:36:09Z

General documentation fixes related to multiple issues

justinbmeyer · 2018-07-25T20:30:19Z

docs/component.md

 <hello-world><h1>Hi There</h1></hello-world>
 ```

+Essentially, the children of the component tag will be treated as it's [can-component/content], 


it's => its

justinbmeyer · 2018-07-25T20:30:51Z

docs/component.md

 ```

+Essentially, the children of the component tag will be treated as it's [can-component/content], 
+to be rendered wherever the tag is provided in the component view.


the <content> tag.

(You might want to be explicit about which tag).

justinbmeyer · 2018-07-25T20:32:41Z

docs/component.md

+Essentially, the children of the component tag will be treated as it's [can-component/content], 
+to be rendered wherever the tag is provided in the component view.
+
+If no view is provided to a Component, it will render it's content naively.


Are you trying to say:

If no LIGHT DOM is provided to a component, it will render the element's LIGHT DOM?

We don't call the LIGHT DOM a view. The view is the component's view property.

By natively it sounds to me like something the BROWSER apis would just do.

Also it's => its

I think maybe it's more accurate to say if there is no view property on a Component, that Component will simply render its LIGHT_DOM

justinbmeyer · 2018-07-25T20:33:33Z

docs/component.md

+<can-el>Here's my content!</can-el>
+```
+
+or you can render viewModel properties using magic tags like : `<can-el>{{hovMessage}}</can-el>`, which renders like:


you can't do this without leakScope.

justinbmeyer · 2018-07-25T20:34:42Z

docs/content.md

 } );
 ```
+
+The children of `<content>` can be used as a default value for rendering in the case that no content is passed.


Instead of "no content is passed", I think we probably should introduce the LIGHT_DOM and SHADOW_DOM concepts?

Or for CanJS, maybe these should be shadow view and light view?

justinbmeyer · 2018-07-25T20:34:55Z

docs/content.md

+```js
+Component.extend( {
+    tag: "my-tag",
+    view: stache( "<h1><content>Hello world</content></h1>" )


lets remove the stache() part.

justinbmeyer · 2018-07-25T20:36:08Z

docs/content.md

+
+`<my-tag>Hello friend</my-tag>` will render:
+
+```html


it would be cool if these were @codepen-able examples:

<my-tag>Hello Friend</my-tag> <script type="module"> import {Component} from "can"; ... </script>

justinbmeyer · 2018-07-25T20:36:47Z

docs/view.md

+
+### Omitting view entirely
+
+If the user does not provide a view property,


Maybe:

If the component does not contain a view property ...

justinbmeyer · 2018-07-25T20:37:41Z

docs/view.md

+
+```js
+Component.extend({
+	tag: "my-greeting",


extra tab here?

Not sure why this is showing up in Github, it doesn't show on my local text editor

This is for canjs/can-component#288

- Show an example of using leakScope to render LIGHT_DOM with a component’s VM - Rename the example component tags (anything with can-* looks like it’s from CanJS) - Various grammar fixes

chasenlehara · 2018-08-06T22:05:01Z

docs/component.md

+
+```js
+Component.extend({
+	leakScope: true,


@justinbmeyer I see your comment here about this only working with leakScope: #288 (comment)

But this definitely works without leakScope right now: https://codepen.io/anon/pen/wxEdyr

Is it a bug? Here’s the issue I originally filed about this: #270

chasenlehara · 2018-08-06T22:05:41Z

docs/ViewModel.md

 following example:

 @demo demos/can-component/accordion.html
+@codepen


All of these should work as of this PR: canjs/canjs#4388

- Add a link to the can-slot and can-template docs - Fix the grammar Closes #264

chasenlehara · 2018-08-06T22:17:12Z

@michaelzcheng I added a few commits to clean up the docs/examples you added. 😊

Michael Cheng added 5 commits July 24, 2018 11:55

add extra "content" documentation to can-component to address #270

dae3d9f

address issue #264, by adding example

eefd91b

address issue #264, by adding example

14646f2

use clearer language for content example

7719927

add codepen to demos

65c71ea

michaelzcheng requested review from justinbmeyer and mikedane July 25, 2018 18:36

justinbmeyer reviewed Jul 25, 2018

View reviewed changes

justinbmeyer requested changes Jul 25, 2018

View reviewed changes

address PR comments

2e6e5f7

chasenlehara added a commit to canjs/canjs that referenced this pull request Aug 6, 2018

Fix the can-component demos so they can be opened in CodePen

b064ecd

This is for canjs/can-component#288

chasenlehara mentioned this pull request Aug 6, 2018

Fix the can-component demos so they can be opened in CodePen canjs/canjs#4388

Merged

Clean up the view docs

52e7d59

- Show an example of using leakScope to render LIGHT_DOM with a component’s VM - Rename the example component tags (anything with can-* looks like it’s from CanJS) - Various grammar fixes

chasenlehara reviewed Aug 6, 2018

View reviewed changes

chasenlehara requested a review from phillipskevin August 6, 2018 22:05

chasenlehara reviewed Aug 6, 2018

View reviewed changes

chasenlehara added 2 commits August 6, 2018 15:13

Clean up the <content> docs

b65fc93

- Add a link to the can-slot and can-template docs - Fix the grammar Closes #264

Clean up the view docs

e5c952a

chasenlehara requested a review from indifferentghost November 15, 2018 02:05


		### Omitting view entirely

		If the user does not provide a view property,

Conversation

michaelzcheng commented Jul 25, 2018

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!

Choose a reason for hiding this comment

Uh oh!

chasenlehara commented Aug 6, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants