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

doc: add break word all for better ux #753

Merged
merged 3 commits into from
Jan 30, 2025
Merged

doc: add break word all for better ux #753

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
664a946
doc: add break word all for better ux
rasvanjaya21 Nov 9, 2024
97f03ea
doc: Remove styles from API docs
franky47 Jan 30, 2025
f74b869
style: Keep inline in sm+ and scroll/ellipsis on overflow
franky47 Jan 30, 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
Next Next commit
doc: add break word all for better ux
  • Loading branch information
@rasvanjaya21 @franky47
rasvanjaya21 authored and franky47 committed Jan 30, 2025
commit 664a946c816ea4e2cd31d4a160a317b2b1630f63
2 changes: 1 addition & 1 deletion demo-tabs.tsx
View file
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@ export function Demo() {
onChange={e => setHello(e.target.value || null)}
data-interacted={Boolean(hello)}
/>
<p>Hello, {hello || 'anonymous visitor'}!</p>
<p className="break-all">Hello, {hello || 'anonymous visitor'}!</p>
Copy link
Member

Choose a reason for hiding this comment

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

suggestion: this file isn't used in the codebase, it was just a demo of how GitHub uses search params to store state, we should probably remove it.

Suggested change
<p className="break-all">Hello, {hello || 'anonymous visitor'}!</p>
<p>Hello, {hello || 'anonymous visitor'}!</p>

</>
)
}
2 changes: 1 addition & 1 deletion packages/docs/content/docs/basic-usage.mdx
View file
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ export function Demo() {
<>
<input value={name || ''} onChange={e => setName(e.target.value)} />
<button onClick={() => setName(null)}>Clear</button>
<p>Hello, {name || 'anonymous visitor'}!</p>
<p className="break-all">Hello, {name || 'anonymous visitor'}!</p>
Copy link
Member

Choose a reason for hiding this comment

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

suggestion: styles are not needed in documentation code blocks, they distract from the main intent (showing how to use nuqs).

Suggested change
<p className="break-all">Hello, {name || 'anonymous visitor'}!</p>
<p>Hello, {name || 'anonymous visitor'}!</p>

</>
)
}
2 changes: 1 addition & 1 deletion packages/docs/src/app/(pages)/_landing/demo.client.tsx
View file
Original file line number Diff line number Diff line change
@@ -25,7 +25,7 @@ export function Demo() {
onChange={e => setHello(e.target.value || null)}
data-interacted={Boolean(hello)}
/>
<p>Hello, {hello || 'anonymous visitor'}!</p>
<p className="break-all">Hello, {hello || 'anonymous visitor'}!</p>
</>
)
}
2 changes: 1 addition & 1 deletion packages/docs/src/app/(pages)/_landing/demo.tsx
View file
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ export async function LandingDemo() {
<div className="mb-4 h-[136px] animate-pulse rounded bg-zinc-50 dark:bg-zinc-900 sm:h-10" />
}
>
<div className="mb-4 flex flex-col gap-4 sm:flex-row sm:items-center">
Copy link
Member

Choose a reason for hiding this comment

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

Looks like this change broke the layout on mobile, the items should be full width:

Screenshot_20241109-103055.jpg

<div className="mb-4 flex flex-col gap-4 items-start sm:flex-row">
<Demo />
<LookAtTheURL />
</div>
Loading