Skip to content

Commit b48b7db

Browse files
authored
Merge pull request #999 from ember-learn/kg-template-tag-codemod-history-fix
2 parents e750dd0 + 32a6f21 commit b48b7db

66 files changed

Lines changed: 1579 additions & 1060 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.git-blame-ignore-revs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
5d6c379a12a3ea7150a44627ec0b151b20552f81
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,10 @@ export default class ApiIndexFilter extends Component {
107107
return nextItem;
108108
}
109109
}
110+
111+
<template>
112+
<div class="api-index-filter">
113+
{{yield this.filteredData}}
114+
</div>
115+
</template>
110116
}

app/components/api-index-filter.hbs

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@ import Component from '@glimmer/component';
2020
/**
2121
* @extends Component<{ Args: Args, Blocks: Blocks }>
2222
*/
23+
import { hash } from '@ember/helper';
2324
export default class ApiIndex extends Component {
25+
<template>
26+
<div>
27+
{{yield (hash sections=this.sections)}}
28+
</div>
29+
</template>
2430
get sections() {
2531
return [
2632
{

app/components/api-index.hbs

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
import { service } from '@ember/service';
2+
import Component from '@glimmer/component';
3+
import join from 'ember-composable-helpers/helpers/join';
4+
import mapBy from 'ember-composable-helpers/helpers/map-by';
5+
import svgJar from 'ember-svg-jar/helpers/svg-jar';
6+
import { LinkTo } from '@ember/routing';
7+
import { array, concat } from '@ember/helper';
8+
import githubLink from 'ember-api-docs/helpers/github-link';
9+
import and from 'ember-truth-helpers/helpers/and';
10+
import eq from 'ember-api-docs/helpers/eq';
11+
import ImportExample from 'ember-api-docs/components/import-example';
12+
import MarkdownToHtml from 'ember-cli-showdown/components/markdown-to-html';
13+
14+
export default class ClassFieldDescription extends Component {
15+
<template>
16+
{{! template-lint-disable no-invalid-interactive }}
17+
<section class="class-field-description {{@type}}">
18+
<h3 id="{{@field.name}}" class="class-field-description--header">
19+
<span class="signature">
20+
<span class="{{@type}}-name">
21+
{{@field.name}}
22+
</span>
23+
{{#if @field.params}}(<span class="args">{{join
24+
", "
25+
(mapBy "name" @field.params)
26+
}}</span>){{/if}}
27+
{{#if @field.return}}
28+
:
29+
<span class="return-type">{{@field.return.type}}</span>
30+
{{/if}}
31+
</span>
32+
{{#if @field.access}}
33+
<span class="access">{{@field.access}}</span>
34+
{{/if}}
35+
{{#if @field.deprecated}}
36+
<span class="access">deprecated</span>
37+
{{/if}}
38+
<a
39+
class="class-field-description--link"
40+
href="#{{@field.name}}"
41+
aria-label="Jump to {{@field.name}}"
42+
>
43+
{{svgJar "link" width="20px" height="20px" aria-hidden="true"}}
44+
</a>
45+
</h3>
46+
{{#if @model.module}}
47+
<div class="attributes">
48+
<div class="attribute">
49+
<span class="attribute-label">Module:</span>
50+
<span class="attribute-value"><LinkTo
51+
@route="project-version.modules.module"
52+
@models={{array
53+
@model.projectVersion.compactVersion
54+
@model.module
55+
}}
56+
>{{@model.module}}</LinkTo></span>
57+
</div>
58+
</div>
59+
{{/if}}
60+
<p class="github-link" data-test-file={{@field.file}}>
61+
{{#if @field.inherited}}
62+
Inherited from
63+
<a
64+
href="{{githubLink
65+
@model.project.id
66+
@model.projectVersion.version
67+
@field.file
68+
@field.line
69+
}}"
70+
target="_blank"
71+
rel="noopener noreferrer"
72+
>
73+
{{@field.inheritedFrom}}
74+
{{@field.file}}:{{@field.line}}
75+
</a>
76+
{{else}}
77+
Defined in
78+
<a
79+
href="{{githubLink
80+
@model.project.id
81+
@model.projectVersion.version
82+
@field.file
83+
@field.line
84+
}}"
85+
target="_blank"
86+
rel="noopener noreferrer"
87+
>
88+
{{@field.file}}:{{@field.line}}
89+
</a>
90+
{{/if}}
91+
</p>
92+
{{#if @field.since}}
93+
<p class="field-since">
94+
Available since v{{@field.since}}
95+
</p>
96+
{{/if}}
97+
{{#if
98+
(and
99+
(eq @field.static 1)
100+
(eq @field.itemtype "method")
101+
this.hasImportExample
102+
)
103+
}}
104+
<ImportExample
105+
@item={{concat "{ " @field.name " }"}}
106+
@package={{@field.class}}
107+
/>
108+
{{/if}}
109+
<dl class="parameters">
110+
{{#each @field.params as |param|}}
111+
<div class="parameter">
112+
<dt>{{param.name}}</dt>
113+
<dd class="parameter-type">{{param.type}}</dd>
114+
<dd><MarkdownToHtml @markdown={{param.description}} /></dd>
115+
{{#if param.props}}
116+
<dl class="parameters">
117+
{{#each param.props as |prop|}}
118+
<div class="prop">
119+
<dt>{{prop.name}}</dt>
120+
<dd class="parameter-type">{{prop.type}}</dd>
121+
<dd><MarkdownToHtml @markdown={{prop.description}} /></dd>
122+
</div>
123+
{{/each}}
124+
</dl>
125+
{{/if}}
126+
</div>
127+
{{/each}}
128+
{{#if @field.return}}
129+
<div class="return">
130+
<dt>returns</dt>
131+
<dd class="return-type">{{@field.return.type}}</dd>
132+
<dd><MarkdownToHtml @markdown={{@field.return.description}} /></dd>
133+
</div>
134+
{{/if}}
135+
</dl>
136+
<MarkdownToHtml @markdown={{@field.description}} />
137+
</section>
138+
</template>
139+
@service
140+
legacyModuleMappings;
141+
142+
get hasImportExample() {
143+
return this.legacyModuleMappings.hasFunctionMapping(
144+
this.args.field.name,
145+
this.args.field.class,
146+
);
147+
}
148+
}

app/components/class-field-description.hbs

Lines changed: 0 additions & 80 deletions
This file was deleted.

app/components/class-field-description.js

Lines changed: 0 additions & 14 deletions
This file was deleted.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
import { LinkTo } from '@ember/routing';
2+
<template>
3+
<article class="chapter">
4+
<h1>
5+
Ember Data API Documentation
6+
</h1>
7+
<hr />
8+
<p>
9+
Ember Data is a library for robustly managing data in applications built
10+
with Ember.js.
11+
</p>
12+
<h2>
13+
Commonly searched-for documentation
14+
</h2>
15+
<ul class="spec-method-list">
16+
<li>
17+
<LinkTo @route="project-version.classes.class" @model="Model">
18+
Model
19+
</LinkTo>
20+
- an object that represents the underlying data that your application
21+
presents to the user.
22+
</li>
23+
<li>
24+
<LinkTo @route="project-version.classes.class" @model="Store">
25+
Store
26+
</LinkTo>
27+
- a service that contains all of the data for records loaded from the
28+
server.
29+
</li>
30+
<li>
31+
<LinkTo @route="project-version.classes.class" @model="Adapter">
32+
Adapter
33+
</LinkTo>
34+
- determines how data is persisted to a backend data store.
35+
</li>
36+
<li>
37+
<LinkTo @route="project-version.classes.class" @model="Serializer">
38+
Serializer
39+
</LinkTo>
40+
- format the data sent to and received from the backend store.
41+
</li>
42+
</ul>
43+
<h2>
44+
Useful links
45+
</h2>
46+
<ul>
47+
<li>
48+
<h5>
49+
<a href="https://github.com/ember-learn/ember-api-docs">
50+
API Documentation Github Repository
51+
</a>
52+
</h5>
53+
</li>
54+
<li>
55+
<h5>
56+
<a href="https://guides.emberjs.com/release/models/">
57+
Introduction to Ember Data
58+
</a>
59+
</h5>
60+
</li>
61+
</ul>
62+
</article>
63+
</template>

0 commit comments

Comments
 (0)