Revise

Author: Tao-VanJS

addons/van_cone/API_REFERENCE.md

@@ -1,4 +1,4 @@
-# Van Cone 
+# Van Cone
 
 See [README.md](./README.md) for installation and overview.
 
@@ -13,11 +13,11 @@ See [README.md](./README.md) for installation and overview.
 
 - `routerElement` - (required) the root DOM element element that holds the app (element defined by active route)
 
-- `routes` - (required) an array of [routes](#routes)
+- `routes` - (required) an array of [`routes`](#routes)
 
-- `defaultNavState` - (optional) the default navigation state, any type allowed by [history.pushState](https://developer.mozilla.org/en-US/docs/Web/API/History/pushState)
+- `defaultNavState` - (optional) the default navigation state, any type allowed by [`history.pushState`](https://developer.mozilla.org/en-US/docs/Web/API/History/pushState)
 
-- [routerConfig](#constructorrouterconfig) = (optional) - configure `prefix` to prepend to each url, or `backendPrefix` if different than frontend.
+- [`routerConfig`](#constructorrouterconfig) = (optional) - configure `prefix` to prepend to each url, or `backendPrefix` if different than frontend.
 
 **return**
 
@@ -27,7 +27,7 @@ An object with the following items is returned:
 
 - `currentPage` - a `van.state` object representing the `name` value of the active route
 
-- `router` - the [router](#router) object for the application
+- `router` - the [`router`](#router) object for the application
 
 - `navState` - a `van.state` object representing the current [`window.history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state)
 
@@ -54,7 +54,7 @@ A list of objects defining each route. Each route object has the following prope
 
 **`callable`** (required) a callback that either returns an element to put on the DOM or another callable that returns this element (for more complex apps requiring imports). The callback is passed 2 arguments, an object representing the params parsed from the URL and another representing parsed query string params.
 
-**`backend`** (optional) provide this value when data is fetched from a different endpoint on the backend than on the frontend. See [router.backendUrl](#backendurlroutename-params---query) for more.
+**`backend`** (optional) provide this value when data is fetched from a different endpoint on the backend than on the frontend. See [`router.backendUrl`](#backendurlroutename-params---query) for more.
 
 **`title`** (optional) if provided the title of the page will change to this when this route is active.
 
@@ -92,7 +92,7 @@ const routes = [
 ```
 
 ### different backend endpoint
-When data is fetched from a different endpoint provide a backend path as follows. See [router.backendUrl](#backendurlroutename-params---query) for information on generating a backend url for fetching data.
+When data is fetched from a different endpoint provide a backend path as follows. See [`router.backendUrl`](#backendurlroutename-params---query) for information on generating a backend url for fetching data.
 ```javascript
 const routes = [
     {
@@ -203,18 +203,18 @@ const userPage = (params, query, context) => {
 ## `router`
 
 #### `constructor(routerConfig)`
-The `routerConfig` object is used to construct a new router, it is an object with two optional keys `prefix` and `backendPrefix`. If `routerConfig` is not provided or either key is not provided they will default to an empty string. 
+The `routerConfig` object is used to construct a new router, it is an object with two optional keys `prefix` and `backendPrefix`. If `routerConfig` is not provided or either key is not provided they will default to an empty string.
 
-`prefix` will be prepended to front end URLs, the ones shown in the browser and matched when navigating to different pages. See [router.navUrl](#navurlroutename-params---query) for more.
+`prefix` will be prepended to front end URLs, the ones shown in the browser and matched when navigating to different pages. See [`router.navUrl`](#navurlroutename-params---query) for more.
 
-The `backendPrefix` is useful for when the backend is at a different host or has a different prefix than the front end. It is only used as a utility to generate URLs for fetching data, it is ignored for route matching and page navigation. See [router.backendUrl](#backendurlroutename-params---query) for more.
+The `backendPrefix` is useful for when the backend is at a different host or has a different prefix than the front end. It is only used as a utility to generate URLs for fetching data, it is ignored for route matching and page navigation. See [`router.backendUrl`](#backendurlroutename-params---query) for more.
 
 #### `navUrl(routeName, params = {}, query = {})`
-Return a string representing a url for the route with name `routeName`, and optionally form url params with the `params` argument or query params with the `query` argument. The return can be used with [navigate](#navigateurl-context) or any other place a url string is needed. If `prefix` was included with [routerConfig](#constructorrouterconfig) it will be prepended to the url.
+Return a string representing a url for the route with name `routeName`, and optionally form url params with the `params` argument or query params with the `query` argument. The return can be used with [`navigate`](#navigateurl-context) or any other place a url string is needed. If `prefix` was included with [`routerConfig`](#constructorrouterconfig) it will be prepended to the url.
 
-**Note: to access this function from the return value of [createCone](#createconerouterelement-routes-defaultnavstate) call `router.navUrl`**
+**Note: to access this function from the return value of [`createCone`](#createconerouterelement-routes-defaultnavstate) call `router.navUrl`**
 
-The following [route](#routes):
+The following [`route`](#routes):
 ```javascript
 {
     path: "/user/:userId",
@@ -231,11 +231,11 @@ router.formatUrl('user', { userId: 123 }, { activeTab: 'profile'})
 ```
 
 #### `backendUrl(routeName, params = {}, query = {})`
-Return a string backend url for the route with name `routeName`, and optionally form url params with the `params` argument or query params with the `query` argument. The return can be used for fetching data. If `backendPrefix` was included with [routerConfig](#constructorrouterconfig) it will be prepended to the url.
+Return a string backend url for the route with name `routeName`, and optionally form url params with the `params` argument or query params with the `query` argument. The return can be used for fetching data. If `backendPrefix` was included with [`routerConfig`](#constructorrouterconfig) it will be prepended to the url.
 
-**Note: to access this function from the return value of [createCone](#createconerouterelement-routes-defaultnavstate) call `router.backendUrl`**
+**Note: to access this function from the return value of [`createCone`](#createconerouterelement-routes-defaultnavstate) call `router.backendUrl`**
 
-The following [routerConfig](#constructorrouterconfig) and [routes](#routes):
+The following [`routerConfig`](#constructorrouterconfig) and [`routes`](#routes):
 ```javascript
 const routerConfig = { backendPrefix: 'http://localhost:8000' }
 
@@ -273,21 +273,21 @@ router.formatUrl('item', { itemId: 123 })
 ## `navigate(url, context)`
 Programmatically navigate to `url`. Optionally pass `context` which can be and data to the resolved router component.
 
-You can use [router.navUrl](#navigateurl-context) to generate urls from named routes with url and query params.
+You can use [`router.navUrl`](#navigateurl-context) to generate urls from named routes with url and query params.
 
 ## `pushHistory(url)`
 Push `url` to browser history and update address bar only, do not modify DOM.
 
-You can use [router.navUrl](#navigateurl-context) to generate urls from named routes with url and query params.
+You can use [`router.navUrl`](#navigateurl-context) to generate urls from named routes with url and query params.
 
 ## `handleNav(event, context)`
 An event wrapper for [`navigate`](#navigateurl-context) to be used with an on click action. `handleNav` will call `event.preventDefault` and then call [`navigate`](#navigateurl-context) with `event.target.href`.
 
-It is used internally to create the [navLink](#navlinkprops-children) component.
+It is used internally to create the [`navLink`](#navlinkprops-children) component.
 
 Optionally pass `context` which can be and data to the resolved router component.
 
-You can use [router.navUrl](#navurlroutename-params---query) to generate urls from named routes and formatting url/query params.
+You can use [`router.navUrl`](#navurlroutename-params---query) to generate urls from named routes and formatting url/query params.
 
 ## `isCurrentPage(pageName)`
 Returns a `van.derive` object with a boolean that is true when `pageName` is the active route
@@ -296,7 +296,7 @@ if (isCurrentPage("home").val) console.log("we're home!")
 ```
 
 ## `navLink(props, ...children)`
-Uses [router.navUrl](#navurlroutename-params---query) to return a link element using `van.tags.a` by passing `props` and `children` to the underling call to `van.tags.a` with a few modifications to the resulting `a` element that adds programmatic navigation and dynamic styling for when it is the active route. URLs are generated using the name of the route, and optional url and query string params.
+Uses [`router.navUrl`](#navurlroutename-params---query) to return a link element using `van.tags.a` by passing `props` and `children` to the underling call to `van.tags.a` with a few modifications to the resulting `a` element that adds programmatic navigation and dynamic styling for when it is the active route. URLs are generated using the name of the route, and optional url and query string params.
 
 ### examples
 A basic call to the route named `home` with the inner text for the a tag `Home`. This is the bare minimum required for `navLink`.
@@ -365,7 +365,7 @@ The following have default values:
 * `props.class` (default: `router-link`)
 
 The following are hardcoded and cannot be changed:
-* `props.href` is set by a call to [router.navUrl](#navurlroutename-params---query) with `props.name`, `props.params` and `props.query`
+* `props.href` is set by a call to [`router.navUrl`](#navurlroutename-params---query) with `props.name`, `props.params` and `props.query`
 * `props.role` is set to `link`
 * `props.onClick` is set to [`handleNav`](#handlenavevent-context)
 

addons/van_cone/README.md

@@ -94,7 +94,7 @@ See the [API Reference](./API_REFERENCE.md) for full documentation.
 
 
 # Support, issues, and suggestions
-Open an issue or discussion either on the [offical repo](https://github.com/vanjs-org/van) or [my fork](https://github.com/b-rad-c/van/tree/main). Make sure to tag my username: [@b-rad-c](https://github.com/b-rad-c).
+Open an issue or discussion either on the [official repo](https://github.com/vanjs-org/van) or [my fork](https://github.com/b-rad-c/van/tree/main). Make sure to tag my username: [@b-rad-c](https://github.com/b-rad-c).
 
 # Contributing
 Got some skills? Want to contribute? Send a pull request!
@@ -105,10 +105,10 @@ I, [@b-rad-c](https://github.com/b-rad-c) am the maintainer of this project howe
 Some things I'm interested in.
 * unittests
 * convert to TypeScript
-* stabilze API to come out of beta - comments or suggestions to the API are welcome.
+* stabilize API to come out of beta - comments or suggestions to the API are welcome.
 
 # The Name
 Van Cone is an addon for VanJS which is short for **Van**illa **J**ava**S**cript, and makes a callout to vanilla ice cream in its logo. Van Cone provides the cone that is needed to support the ice cream. VanJS provides reactivity and UI components, Van Cone provides routing, history and navigation components, together they're everything you need for a lightweight SPA experience!
 
 # Credit
-router based on [minimal router](https://github.com/jmhdez/minimal-router) (no longer maintained)
+Router based on [minimal router](https://github.com/jmhdez/minimal-router) (no longer maintained).