Skip to content

feat(#2594): document link component#348

Merged
chrisolsen merged 1 commit into
alphafrom
benjifranck/feat-2594
May 1, 2025
Merged

feat(#2594): document link component#348
chrisolsen merged 1 commit into
alphafrom
benjifranck/feat-2594

Conversation

@bdfranck
Copy link
Copy Markdown
Collaborator

@bdfranck bdfranck commented Apr 29, 2025

This PR adds documentation for the Link component which now works with our alpha Angular and React components. (Implemented in GovAlta/ui-components#2522)

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 29, 2025

Deploy Preview for abgov-ui-component-docs ready!

Name Link
🔨 Latest commit daaa4b9
🔍 Latest deploy log https://app.netlify.com/sites/abgov-ui-component-docs/deploys/68129c3994cff8000831b229
😎 Deploy Preview https://deploy-preview-348--abgov-ui-component-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@bdfranck bdfranck force-pushed the benjifranck/feat-2594 branch from f6daab6 to 816348f Compare April 29, 2025 21:22
@bdfranck bdfranck linked an issue Apr 29, 2025 that may be closed by this pull request
@bdfranck bdfranck requested a review from Copilot April 29, 2025 21:37
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds documentation and usage examples for the new Link component to support our alpha Angular and React components. Key changes include:

  • Updating routing (versioned-router.tsx) and side menus (Components.tsx, AllComponents.tsx) to include the Link component.
  • Introducing the LinkPage component with an interactive sandbox and property definitions (Link.tsx).
  • Providing examples of the Link component usage (LinkExamples.tsx).

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/versioned-router.tsx Routes now include LinkPage for the Link component.
src/routes/components/Link.tsx New LinkPage documentation and sandbox implementation.
src/routes/components/Components.tsx Added Link entry to the component side menu.
src/routes/components/AllComponents.tsx Registers Link in the published component list.
src/examples/link/LinkExamples.tsx Provides interactive examples for the Link component.
Comments suppressed due to low confidence (1)

src/routes/components/Link.tsx:48

  • The properties 'leadingIcon' and 'leadingicon' differ only in letter casing for React and Angular, which might be confusing. Consider consolidating them or clearly documenting the intent.
    { name: "leadingIcon", type: "GoAIconType", lang: "react", description: "Shows an icon to the left of the link." },

Comment thread src/routes/components/Link.tsx
Comment thread src/examples/link/LinkExamples.tsx
@bdfranck bdfranck marked this pull request as ready for review April 29, 2025 21:40
@bdfranck bdfranck requested a review from twjeffery April 30, 2025 14:53
Comment thread src/routes/components/Link.tsx Outdated
Comment thread src/routes/components/Link.tsx
Comment thread src/routes/components/Link.tsx
Comment thread src/routes/components/Link.tsx Outdated
Comment thread src/routes/components/Link.tsx Outdated
@bdfranck bdfranck force-pushed the benjifranck/feat-2594 branch from 816348f to 92c6acb Compare April 30, 2025 19:54
@bdfranck
Copy link
Copy Markdown
Collaborator Author

@twjeffery Thanks for the review! I've amended my commit with the following changes:

  • Added the Figma link and GitHub link to the appropriate locations
  • Added the related component section
  • Changed the label of the design tab to "Design"
  • Removed the badge from the design tab label
  • Added the accessibility tab
  • Added the new empty state for design and accessibility

@bdfranck bdfranck requested a review from twjeffery April 30, 2025 20:02
@bdfranck bdfranck force-pushed the benjifranck/feat-2594 branch from 92c6acb to daaa4b9 Compare April 30, 2025 21:55
Copy link
Copy Markdown
Collaborator

@twjeffery twjeffery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look great, approved by me

@chrisolsen chrisolsen merged commit 94fb7ce into alpha May 1, 2025
7 checks passed
@chrisolsen chrisolsen deleted the benjifranck/feat-2594 branch May 1, 2025 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document GoA "link" component

4 participants