Skip to content

Polish existing review surfaces #3

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

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

Polish existing review surfaces #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6cd203
Unify pull request source overview layout
xortive Jul 21, 2026
44778f2
Keep the walkthrough arc fixed above local content
xortive Jul 21, 2026
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
31 changes: 20 additions & 11 deletions core/App.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1756,23 +1756,28 @@ html[data-codiff-platform='darwin'] .sidebar {
padding: 0 8px 8px 50px;
}

.codiff-source-description-footer-row {
align-items: stretch;
.codiff-source-description-overview {
align-items: start;
display: grid;
gap: 8px;
grid-template-columns: minmax(0, 1fr) minmax(260px, 320px);
gap: 12px;
grid-template-columns: minmax(0, 1fr) minmax(340px, 380px);
min-width: 0;
}

.codiff-source-description-overview-main,
.codiff-source-description-overview-aside {
min-width: 0;
}

.codiff-source-description-footer-main,
.codiff-source-description-footer-aside {
.codiff-source-description-overview-aside {
display: flex;
flex-direction: column;
min-width: 0;
gap: 8px;
padding: 8px 8px 8px 0;
}

.codiff-source-description-footer-main > *,
.codiff-source-description-footer-aside > * {
flex: 1;
.codiff-source-description-overview-aside > * {
min-width: 0;
}

.source-description-comment-anonymous + .codiff-source-description-footer {
Expand Down Expand Up @@ -1982,10 +1987,14 @@ html[data-codiff-platform='darwin'] .sidebar {
}

@media (max-width: 1024px) {
.codiff-source-description-footer-row {
.codiff-source-description-overview {
grid-template-columns: minmax(0, 1fr);
}

.codiff-source-description-overview-aside {
padding: 0 8px 8px;
}

.pull-request-merge-controls,
.pull-request-merge-actions {
justify-content: flex-start;
Expand Down
18 changes: 6 additions & 12 deletions core/SharedWalkthroughApp.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -840,20 +840,12 @@ export function ReviewSurface({
onMergePullRequest={mergePullRequest}
/>
) : undefined;
const sourceDescriptionFooter =
sourceDescriptionFooterMain && sourceDescriptionFooterAside ? (
<div className="codiff-source-description-footer-row">
<div className="codiff-source-description-footer-main">{sourceDescriptionFooterMain}</div>
<div className="codiff-source-description-footer-aside">{sourceDescriptionFooterAside}</div>
</div>
) : (
(sourceDescriptionFooterMain ?? sourceDescriptionFooterAside)
);
const sourceDescription =
source.type === 'pull-request' ? (
<PullRequestSourceDescription
actions={sourceDescriptionActions}
footer={sourceDescriptionFooter}
footer={sourceDescriptionFooterMain}
footerAside={sourceDescriptionFooterAside}
keymap={keymap}
onUpdateDescription={interactive?.onUpdateDescription}
onUpdateTitle={interactive?.onUpdateTitle}
Expand All @@ -875,7 +867,8 @@ export function ReviewSurface({
reviewProps={commonReviewProps}
scrollTarget={blockScrollTarget}
sourceDescriptionActions={sourceDescriptionActions}
sourceDescriptionFooter={sourceDescriptionFooter}
sourceDescriptionFooter={sourceDescriptionFooterMain}
sourceDescriptionFooterAside={sourceDescriptionFooterAside}
/>
);
};
Expand Down Expand Up @@ -1158,7 +1151,8 @@ export function ReviewSurface({
scrollTarget={treeScrollTarget}
selectedPath={visibleSelectedPath}
sourceDescriptionActions={sourceDescriptionActions}
sourceDescriptionFooter={sourceDescriptionFooter}
sourceDescriptionFooter={sourceDescriptionFooterMain}
sourceDescriptionFooterAside={sourceDescriptionFooterAside}
walkthroughNotes={emptyWalkthroughNotes}
/>
)
Expand Down
100 changes: 75 additions & 25 deletions core/app/components/ReviewCodeView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -943,6 +943,7 @@ function SourceDescriptionBody({
export function PullRequestSourceDescription({
actions,
footer,
footerAside,
keymap,
onUpdateDescription,
onUpdateTitle,
Expand All @@ -951,6 +952,7 @@ export function PullRequestSourceDescription({
}: {
actions?: ReactNode;
footer?: ReactNode;
footerAside?: ReactNode;
keymap?: CodiffKeymap;
onUpdateDescription?: (body: string) => Promise<void> | void;
onUpdateTitle?: (title: string) => Promise<void> | void;
Expand All @@ -972,6 +974,25 @@ export function PullRequestSourceDescription({

const isCollapsed = (!sourceDescriptionHasBody && !canEditDescription) || collapsed;
const layoutKey = `source-description-panel:${source.provider ?? ''}:${source.url}:${sourceTitle}:${sourceDescription}:${source.author?.login ?? ''}:${source.author?.avatarUrl ?? ''}:${isCollapsed ? 'collapsed' : 'open'}`;
const sourceDescriptionContent = (
<SourceDescriptionBody
author={sourceAuthor}
canEdit={canEditDescription}
description={sourceDescription}
keymap={keymap}
layoutKey={layoutKey}
onLayoutReady={() => {}}
onUpdateDescription={onUpdateDescription}
onUploadDescriptionAsset={onUploadDescriptionAsset}
/>
);
const overviewAside =
footer || footerAside ? (
<aside className="codiff-source-description-overview-aside">
{footer}
{footerAside}
</aside>
) : null;

return (
<div className="codiff-source-description-panel">
Expand All @@ -987,17 +1008,19 @@ export function PullRequestSourceDescription({
/>
{!isCollapsed ? (
<div className="codiff-source-description-panel-body">
<SourceDescriptionBody
author={sourceAuthor}
canEdit={canEditDescription}
description={sourceDescription}
keymap={keymap}
layoutKey={layoutKey}
onLayoutReady={() => {}}
onUpdateDescription={onUpdateDescription}
onUploadDescriptionAsset={onUploadDescriptionAsset}
/>
{footer ? <div className="codiff-source-description-footer">{footer}</div> : null}
{overviewAside ? (
<div className="codiff-source-description-overview">
<div className="codiff-source-description-overview-main">
{sourceDescriptionContent}
</div>
{overviewAside}
</div>
) : (
<>
{sourceDescriptionContent}
{footer ? <div className="codiff-source-description-footer">{footer}</div> : null}
</>
)}
</div>
) : null}
</div>
Expand Down Expand Up @@ -2486,6 +2509,7 @@ export function ReviewCodeView({
source,
sourceDescriptionActions,
sourceDescriptionFooter,
sourceDescriptionFooterAside,
supportsReviewCommentActions,
theme = 'system',
viewed,
Expand Down Expand Up @@ -2546,6 +2570,7 @@ export function ReviewCodeView({
source: ReviewSource;
sourceDescriptionActions?: ReactNode;
sourceDescriptionFooter?: ReactNode;
sourceDescriptionFooterAside?: ReactNode;
supportsReviewCommentActions: boolean;
theme?: CodiffPreferences['theme'];
viewed: Record<string, string>;
Expand Down Expand Up @@ -3802,20 +3827,44 @@ export function ReviewCodeView({
{!sourceDescriptionCollapsed &&
(sourceDescriptionHasContent || canEditSourceDescription) ? (
<div className="codiff-source-description-panel-body">
<SourceDescriptionBody
ariaLabel={sourceDescriptionAriaLabel}
author={sourceAuthor}
canEdit={canEditSourceDescription}
description={sourceDescription}
keymap={keymap}
layoutKey="code-view-header"
onLayoutReady={noopLayoutReady}
onUpdateDescription={onUpdateSourceDescription}
onUploadDescriptionAsset={onUploadSourceDescriptionAsset}
/>
{sourceDescriptionFooter ? (
<div className="codiff-source-description-footer">{sourceDescriptionFooter}</div>
) : null}
{sourceDescriptionFooter || sourceDescriptionFooterAside ? (
<div className="codiff-source-description-overview">
<div className="codiff-source-description-overview-main">
<SourceDescriptionBody
ariaLabel={sourceDescriptionAriaLabel}
author={sourceAuthor}
canEdit={canEditSourceDescription}
description={sourceDescription}
keymap={keymap}
layoutKey="code-view-header"
onLayoutReady={noopLayoutReady}
onUpdateDescription={onUpdateSourceDescription}
onUploadDescriptionAsset={onUploadSourceDescriptionAsset}
/>
</div>
<aside className="codiff-source-description-overview-aside">
{sourceDescriptionFooter}
{sourceDescriptionFooterAside}
</aside>
</div>
) : (
<>
<SourceDescriptionBody
ariaLabel={sourceDescriptionAriaLabel}
author={sourceAuthor}
canEdit={canEditSourceDescription}
description={sourceDescription}
keymap={keymap}
layoutKey="code-view-header"
onLayoutReady={noopLayoutReady}
onUpdateDescription={onUpdateSourceDescription}
onUploadDescriptionAsset={onUploadSourceDescriptionAsset}
/>
{sourceDescriptionFooter ? (
<div className="codiff-source-description-footer">{sourceDescriptionFooter}</div>
) : null}
</>
)}
</div>
) : null}
</div>
Expand All @@ -3833,6 +3882,7 @@ export function ReviewCodeView({
sourceDescriptionAriaLabel,
sourceDescriptionCollapsed,
sourceDescriptionFooter,
sourceDescriptionFooterAside,
sourceDescriptionHasContent,
sourceDescriptionLabel,
sourceTitle,
Expand Down
38 changes: 22 additions & 16 deletions core/app/components/walkthrough/NarrativeWalkthroughView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -663,21 +663,26 @@ export function NarrativeWalkthroughView({
}
: null;

const arc = (
<Arc
committable={committable}
navigation={navigation}
onShareWalkthrough={onShareWalkthrough}
shareWalkthroughDisabled={shareWalkthroughDisabled}
supportAvailable={supportAvailable}
walkthroughView={walkthroughView}
/>
);

return (
<div
className="wt-hybrid"
onPointerDownCapture={navigation.releaseStopScrollLock}
onTouchStartCapture={navigation.releaseStopScrollLock}
onWheelCapture={navigation.releaseStopScrollLock}
>
<Arc
committable={committable}
navigation={navigation}
onShareWalkthrough={onShareWalkthrough}
shareWalkthroughDisabled={shareWalkthroughDisabled}
supportAvailable={supportAvailable}
walkthroughView={walkthroughView}
/>
<>
{arc}
<div
className="wt-hybrid"
onPointerDownCapture={navigation.releaseStopScrollLock}
onTouchStartCapture={navigation.releaseStopScrollLock}
onWheelCapture={navigation.releaseStopScrollLock}
>

{navigation.mode === 'commit' ? (
<CommitView
Expand Down Expand Up @@ -782,7 +787,8 @@ export function NarrativeWalkthroughView({
<span className="wt-upnext-file">Chapter {navigation.index + 1}</span>
</span>
</button>
) : null}
</div>
) : null}
</div>
</>
);
}
5 changes: 5 additions & 0 deletions core/app/components/walkthrough/WalkthroughDiffSurface.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ export function WalkthroughDiffSurface({
scrollTarget,
sourceDescriptionActions,
sourceDescriptionFooter,
sourceDescriptionFooterAside,
}: {
allowViewedToggle?: boolean;
blocks: ReadonlyArray<ReviewDiffBlock>;
Expand All @@ -44,6 +45,7 @@ export function WalkthroughDiffSurface({
scrollTarget: WalkthroughBlockScrollTarget | null;
sourceDescriptionActions?: ReviewCodeViewProps['sourceDescriptionActions'];
sourceDescriptionFooter?: ReviewCodeViewProps['sourceDescriptionFooter'];
sourceDescriptionFooterAside?: ReviewCodeViewProps['sourceDescriptionFooterAside'];
}) {
return (
<div className="wt-stop wt-diff-surface">
Expand All @@ -62,6 +64,9 @@ export function WalkthroughDiffSurface({
showSourceDescription
sourceDescriptionActions={sourceDescriptionActions ?? reviewProps.sourceDescriptionActions}
sourceDescriptionFooter={sourceDescriptionFooter ?? reviewProps.sourceDescriptionFooter}
sourceDescriptionFooterAside={
sourceDescriptionFooterAside ?? reviewProps.sourceDescriptionFooterAside
}
walkthroughNotes={emptyWalkthroughNotes}
/>
</div>
Expand Down