Skip to content

Fix developer setup page code snippets #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrisolsen merged 4 commits into from
Apr 2, 2025
Merged

Fix developer setup page code snippets #336

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ed5a773
fix(#2550): remove the `lts` tag from the setup instructions
chrisolsen Apr 2, 2025
63f2c78
fix(#2550): remove the `tags` prop from the CodeSnippets
chrisolsen Apr 2, 2025
8563aba
chore(#2550): formatting fixes
chrisolsen Apr 2, 2025
6e3ddcd
Merge pull request #335 from GovAlta/CO-2550-fix-docs
chrisolsen Apr 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 8 additions & 36 deletions src/routes/get-started/developers/DevelopersSetup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,16 @@ export default function DevelopersSetupPage() {
<h4>1. Add Dependencies</h4>
<CodeSnippet
lang="typescript"
tags="react"
allowCopy={true}
code={`
npm i @abgov/web-components
npm i @abgov/angular-components@lts
npm i @abgov/angular-components
`}
/>

<h4>2. Link ionicons in app/index.html Add the following in the head element</h4>
<CodeSnippet
lang="typescript"
tags="react"
allowCopy={true}
code={`
<script type="module" src="https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.esm.js"></script>
Expand All @@ -42,7 +40,6 @@ export default function DevelopersSetupPage() {
<h4>3. Update src/app/app.module.ts as per the four steps below</h4>
<CodeSnippet
lang="typescript"
tags="react"
allowCopy={true}
code={`
// 1. Import the CUSTOM_ELEMENTS_SCHEMA
Expand Down Expand Up @@ -70,7 +67,6 @@ export default function DevelopersSetupPage() {
<h4>4. Add the styles link in the src/styles.css file</h4>
<CodeSnippet
lang="typescript"
tags="react"
allowCopy={true}
code={`@import "@abgov/web-components/index.css";`}
/>
Expand All @@ -86,18 +82,16 @@ export default function DevelopersSetupPage() {
<h4>1. Add Dependencies</h4>
<CodeSnippet
lang="typescript"
tags="react"
allowCopy={true}
code={`
npm i @abgov/react-components@lts
npm i @abgov/react-components
npm i @abgov/web-components
`}
/>

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

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

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

<h4>1. Add Dependencies</h4>
<CodeSnippet
lang="typescript"
tags="react"
allowCopy={true}
code={`npm i @abgov/web-components`}
/>

<h4>2. Link ionicons in index.html Add the following in the head element</h4>
<CodeSnippet
lang="typescript"
tags="react"
allowCopy={true}
code={`
<script type="module" src="https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.esm.js"></script>
<script nomodule src="https://cdn.jsdelivr.net/npm/ionicons@latest/dist/ionicons/ionicons.js"></script>
`}
/>

<h4>3. Update vite.config.js with the following:</h4>
<h4>3. Import the web-components into src/main.js:</h4>
<CodeSnippet
lang="typescript"
tags="react"
allowCopy={true}
code={`
plugins: [
vue({
template: {
compilerOptions: {
// treat all tags with goa- as custom elements
isCustomElement: (tag) => tag.includes('goa-')
}
}
})],
`}
/>

<h4>4. Import the web-components into src/main.js:</h4>
<CodeSnippet
lang="typescript"
tags="react"
allowCopy={true}
code={`import "@abgov/web-components";`}
/>

<h4>
5. Add the styles link in the src/assets/main.css file or wherever your main css file is
4. Add the styles link in the src/assets/main.css file or wherever your main css file is
located:
</h4>
<CodeSnippet
lang="typescript"
tags="react"
allowCopy={true}
code={`@import "@abgov/web-components/index.css";`}
/>
Expand Down Expand Up @@ -211,8 +182,9 @@ export default function DevelopersSetupPage() {
<code>npm run build</code>
</li>
<li>
<code>npm run start</code>-- if using Angular, <code>npm run dev</code> --if using
react
<code>npm run start # Angular</code>
<br />
<code>npm run dev # React</code>
</li>
</ol>
</li>
Expand Down