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.

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(tutorial): remove line breaks in new route definitions #12932

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

dadamssg
Copy link
Contributor

@dadamssg dadamssg commented Feb 1, 2025

Every time I saw the route config additions where the route() arguments were broken across two lines it took me way too long to realize I was only looking at a single route. I would suggest not breaking. I know this will be worse for mobile but it's a bit jarring.

export default [
  layout("layouts/sidebar.tsx", [
    index("routes/home.tsx"),
    route("contacts/:contactId", "routes/contact.tsx"),
--  route(
--    "contacts/:contactId/edit",
--    "routes/edit-contact.tsx"
--  ),
++  route("contacts/:contactId/edit", "routes/edit-contact.tsx"),
  ]),
  route("about", "routes/about.tsx"),
] satisfies RouteConfig;
export default [
  // existing routes
--  route(
--    "contacts/:contactId/destroy",
--    "routes/destroy-contact.tsx"
--  ),
++  route("contacts/:contactId/destroy", "routes/destroy-contact.tsx"),
  // existing routes
] satisfies RouteConfig;

Copy link

changeset-bot bot commented Feb 1, 2025

⚠️ No Changeset found

Latest commit: 2aab1e9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Feb 1, 2025

Hi @dadamssg,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

@dadamssg dadamssg force-pushed the docs-remove-route-line-breaks branch from fcb50ec to 2aab1e9 Compare February 1, 2025 03:00
@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Feb 1, 2025

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

@JimmayVV
Copy link

JimmayVV commented Feb 7, 2025

I really don't want to get into a argument about whitespacing but respectfully I disagree with this proposal.

The concern you mentioned seems completely subjective, and dismisses the accessibility loss mobile users will suffer.

This syntax is not only standards compliant JS/TS, but it's extremely common syntax, and I don't think it's realistic to expect the tutorial to make accommodations for every person's version of "illegible content", especially like I said with the accessibility loss this would present to mobile users.

Just my 2 cents. The React Router docs are one of the most mobile friendly docs I have ever seen and I just don't see the juice as worth the squeeze to harm it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants