search

solidjs / solid-router

A universal router for Solid inspired by Ember and React Router
MIT License
1.14k stars 146 forks source link

README has reference to `element` which no longer exists. #388

Closed klequis closed 7 months ago

klequis commented 7 months ago

Describe the bug

A documentation issue, not a bug. I didn't see an option to open a doc issue here.

I think there is an error in the README file in the text below. If the word "element" here refers to the element prop of the Router component, that prop is not part of this version of the router.

Configure Your Routes Solid Router allows you to configure your routes using JSX:

Add each route to a using the Route component, specifying a path and an element or component to render when the user navigates to that path. ---refers

Your Example Website or App

https://github.com/solidjs/solid-router/blob/main/README.md

Steps to Reproduce the Bug or Issue

README.md in this repository

Expected behavior

change

Add each route to a using the Route component, specifying a path and an element or component to render when the user navigates to that path.

to

Add each route to a using the Route component, specifying a path and a component to render when the user navigates to that path.

Screenshots or Videos

No response

Platform

Does not apply

Additional context

No response