Skip to content

Commit 122b13d

Browse files
authored
Merge pull request #336 from GovAlta/alpha
Fix developer setup page code snippets
2 parents 1605fd2 + 6e3ddcd commit 122b13d

File tree

1 file changed

+8
-36
lines changed

1 file changed

+8
-36
lines changed

src/routes/get-started/developers/DevelopersSetup.tsx

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,16 @@ export default function DevelopersSetupPage() {
2020
<h4>1. Add Dependencies</h4>
2121
<CodeSnippet
2222
lang="typescript"
23-
tags="react"
2423
allowCopy={true}
2524
code={`
2625
npm i @abgov/web-components
27-
npm i @abgov/angular-components@lts
26+
npm i @abgov/angular-components
2827
`}
2928
/>
3029

3130
<h4>2. Link ionicons in app/index.html Add the following in the head element</h4>
3231
<CodeSnippet
3332
lang="typescript"
34-
tags="react"
3533
allowCopy={true}
3634
code={`
3735
<script type="module" src="https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.esm.js"></script>
@@ -42,7 +40,6 @@ export default function DevelopersSetupPage() {
4240
<h4>3. Update src/app/app.module.ts as per the four steps below</h4>
4341
<CodeSnippet
4442
lang="typescript"
45-
tags="react"
4643
allowCopy={true}
4744
code={`
4845
// 1. Import the CUSTOM_ELEMENTS_SCHEMA
@@ -70,7 +67,6 @@ export default function DevelopersSetupPage() {
7067
<h4>4. Add the styles link in the src/styles.css file</h4>
7168
<CodeSnippet
7269
lang="typescript"
73-
tags="react"
7470
allowCopy={true}
7571
code={`@import "@abgov/web-components/index.css";`}
7672
/>
@@ -86,18 +82,16 @@ export default function DevelopersSetupPage() {
8682
<h4>1. Add Dependencies</h4>
8783
<CodeSnippet
8884
lang="typescript"
89-
tags="react"
9085
allowCopy={true}
9186
code={`
92-
npm i @abgov/react-components@lts
87+
npm i @abgov/react-components
9388
npm i @abgov/web-components
9489
`}
9590
/>
9691

9792
<h4>2. Link ionicons in app/index.html Add the following to the head element</h4>
9893
<CodeSnippet
9994
lang="typescript"
100-
tags="react"
10195
allowCopy={true}
10296
code={`
10397
<script type="module" src="https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.esm.js"></script>
@@ -108,68 +102,45 @@ export default function DevelopersSetupPage() {
108102
<h4>3. Import the web-component styles in the src/index.css file</h4>
109103
<CodeSnippet
110104
lang="typescript"
111-
tags="react"
112105
allowCopy={true}
113106
code={`@import "@abgov/web-components/index.css";`}
114107
/>
115108

116109
<GoabDivider mt="2xl" mb="xl" />
117110

118-
<h3 id="vue">Vue web components</h3>
111+
<h3 id="web-components">Web components</h3>
119112
<p>This library contains react components from the Government of Alberta.</p>
120113

121114
<h4>1. Add Dependencies</h4>
122115
<CodeSnippet
123116
lang="typescript"
124-
tags="react"
125117
allowCopy={true}
126118
code={`npm i @abgov/web-components`}
127119
/>
128120

129121
<h4>2. Link ionicons in index.html Add the following in the head element</h4>
130122
<CodeSnippet
131123
lang="typescript"
132-
tags="react"
133124
allowCopy={true}
134125
code={`
135126
<script type="module" src="https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.esm.js"></script>
136127
<script nomodule src="https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.js"></script>
137128
`}
138129
/>
139130

140-
<h4>3. Update vite.config.js with the following:</h4>
131+
<h4>3. Import the web-components into src/main.js:</h4>
141132
<CodeSnippet
142133
lang="typescript"
143-
tags="react"
144-
allowCopy={true}
145-
code={`
146-
plugins: [
147-
vue({
148-
template: {
149-
compilerOptions: {
150-
// treat all tags with goa- as custom elements
151-
isCustomElement: (tag) => tag.includes('goa-')
152-
}
153-
}
154-
})],
155-
`}
156-
/>
157-
158-
<h4>4. Import the web-components into src/main.js:</h4>
159-
<CodeSnippet
160-
lang="typescript"
161-
tags="react"
162134
allowCopy={true}
163135
code={`import "@abgov/web-components";`}
164136
/>
165137

166138
<h4>
167-
5. Add the styles link in the src/assets/main.css file or wherever your main css file is
139+
4. Add the styles link in the src/assets/main.css file or wherever your main css file is
168140
located:
169141
</h4>
170142
<CodeSnippet
171143
lang="typescript"
172-
tags="react"
173144
allowCopy={true}
174145
code={`@import "@abgov/web-components/index.css";`}
175146
/>
@@ -211,8 +182,9 @@ export default function DevelopersSetupPage() {
211182
<code>npm run build</code>
212183
</li>
213184
<li>
214-
<code>npm run start</code>-- if using Angular, <code>npm run dev</code> --if using
215-
react
185+
<code>npm run start # Angular</code>
186+
<br />
187+
<code>npm run dev # React</code>
216188
</li>
217189
</ol>
218190
</li>

0 commit comments

Comments
 (0)