Skip to content
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

docs: added support for commit-copy-action #1241

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

docs: added support for commit-copy-action #1241

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
37c3dbd
docs: added support for commit-copy-action
harish-viswa Mar 12, 2025
195b22f
Update apps/portal/src/content/docs/components/commit-copy-action.mdx
harish-viswa Mar 14, 2025
3146394
Update apps/portal/src/content/docs/components/commit-copy-action.mdx
harish-viswa Mar 14, 2025
7c8b422
Update apps/portal/src/content/docs/components/commit-copy-action.mdx
harish-viswa Mar 14, 2025
2f7f6cf
Update apps/portal/src/content/docs/components/commit-copy-action.mdx
harish-viswa Mar 14, 2025
a08cb51
Update apps/portal/src/content/docs/components/commit-copy-action.mdx
harish-viswa Mar 14, 2025
0a31086
Update apps/portal/src/content/docs/components/commit-copy-action.mdx
harish-viswa Mar 14, 2025
4b71261
Update apps/portal/src/content/docs/components/commit-copy-action.mdx
harish-viswa Mar 14, 2025
9a2d83d
fix: added review changes
harish-viswa Mar 27, 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
64 changes: 64 additions & 0 deletions apps/portal/src/content/docs/components/commit-copy-action.mdx
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we rename this file to match the name of the component?

Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: CommitCopyActions
description: CommitCopyActions component
---

The `CommitCopyActions` component provides a UI element for displaying a commit SHA and copying it to the clipboard. It also allows navigation to the commit details page.

import { DocsPage } from "@/components/docs-page";

<DocsPage.ComponentExample
client:only
code={`<div className="flex">
<CommitCopyActions sha="abc1234" toCommitDetails={({ sha }) => "/commit/" + sha} />
</div>`}
/>

## Usage

```typescript jsx
import { CommitCopyActions } from '@harnessio/ui/components'

// ...

return (
<div className="flex">
<CommitCopyActions
sha="abc1234"
toCommitDetails={({ sha }) => `/commit/${sha}`}
/>
</div>
)
```

## API Reference

The `CommitCopyActions` component provides action to copy commit sha to clipboard and navigate to commit details page.

```typescript jsx
<div className="flex">
<CommitCopyActions
sha="abc1234"
toCommitDetails={({ sha }) => `/commit/${sha}`}
Comment on lines +41 to +42
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we add the inline comments to describe the props?

Suggested change
sha="abc1234"
toCommitDetails={({ sha }) => `/commit/${sha}`}
sha="abc1234" // SHA hash to copy to clipboard
toCommitDetails={({ sha }) => `/commit/${sha}`} // callback to get the unique URL to navigate to on click

/>
</div>
```

<DocsPage.PropsTable
props={[
{
name: "sha",
description:
"The commit SHA to display and copy. This will be shown in the UI and can be copied to clipboard.",
required: true,
value: "string",
},
{
name: "toCommitDetails",
description:
"Function that takes the SHA and returns a URL for navigating to the commit details page",
required: false,
value: "({ sha }: { sha: string }) => string",
},
]}
/>