mirror of
https://github.com/nocobase/nocobase
synced 2024-11-16 14:16:20 +00:00
2cb1203aa4
BREAKING CHANGE:
* refactor: update umi version 3.x to version 4.x
* refactor: update react-router-dom version to 6.x
* refactor(react-router-dom): change Layout Component `props.children` to `<Outlet />`
* refactor(react-router-dom): change <Route /> props and <RouteSwitch /> correct
* refactor(react-router-dom): replace `<Redirect />` to `<Navigate replace />`
* refactor(react-router-dom): replace `useHistory` to `useNavigate`
* refactor(react-router-dom): replace `useRouteMatch` to `useParams`
* refactor(react-router-dom & dumi): fix <RouteSwitch /> & umi document bug
* refactor(react-router-dom): `useRoutes` Optimize `<RouteSwitch />` code
* refactor(react-router-dom): update `Route` types and docs
* refactor(react-router-dom): optimize RouteSwitch code
* refactor(react-router-dom): `useLocation` no generics type
* refactor(react-router-dom): add `less v3.9.0` to `resolutions` to solve the error of `gulp-less`
* refactor(react-router-dom): fix `<RouteSwitch />` `props.routes` as an array is not handled
* chore: upgrade `dumi` and refactor docs
* fix: completed code review, add `targets` to solve browser compatibility & removed `chainWebpack`
* refactor(dumi): upgraded dumi under `packages/core/client`
* refactor(dumi): delete `packages/core/dumi-theme-nocobase`
* refactor(dumi): degrade `react` & replace `dumi-theme-antd` to `dumi-theme-nocobase`
* refactor(dumi): solve conflicts between multiple dumi applications
* fix: login page error in react 17
* refactor(dumi): remove less resolutions
* refactor(dumi): umi add `msfu: true` config
* fix: merge bug
* fix: self code review
* fix: code reivew and test bug
* refactor: upgrade react to 18
* refactor: degrade react types to 17
* chore: fix ci error
* fix: support routerBase & fix workflow page params
* fix(doc): menu externel link
* fix: build error
* fix: delete
* fix: vitest error
* fix: react-router new code replace
* fix: vitest markdown error
* fix: title is none when refresh
* fix: merge error
* fix: sidebar width is wrong
* fix: useProps error
* fix: side-menu-width
* fix: menu selectId is wrong & useProps is string
* fix: menu selected first default & side menu hide when change
* fix: test error & v0.10 change log
* fix: new compnent doc modify
* fix: set umi `fastRefresh=false`
* refactor: application v2
* fix: improve code
* fix: bug
* fix: page = 0 error
* fix: workflow navigate error
* feat: plugin manager
* fix: afterAdd
* feat: complete basic functional refactor
* fix: performance Application
* feat: support client and server build
* refactor: nocobase build-in plugin and providers
* fix: server can't start
* refactor: all plugins package `Prodiver` change to `Plugin`
* feat: nested router and change mobile client
* feat: delete application-v1 and router-switch
* feat: improve routes
* fix: change mobile not nested
* feat: delete RouteSwitchContext and change buildin Provider to Plugin
* feat: delete RouteSwitchContext plugins
* fix: refactor SchemaComponentOptions
* feat: improve SchemaComponentOptions
* fix: add useAdminSchemaUid
* fix: merge master error
* fix: vitest error
* fix: bug
* feat: bugs
* fix: improve code
* fix: restore code
* feat: vitest
* fix: bugs
* fix: bugs
* docs: update doc
* feat: improve code
* feat: add docs and imporve code
* fix: bugs
* feat: add tests
* fix: remove deps
* fix: muti app router error
* fix: router error
* fix: workflow error
* fix: cli error
* feat: change NoCobase -> Nocobase
* fix: code review
* fix: type error
* fix: cli error and plugin demo
* feat: update doc theme
* fix: build error
* fix: mobile router
* fix: code rewview
* fix: bug
* fix: test bug
* fix: bug
* refactor: add the "client" directory to all plugins
* refactor: modify samples client and plugin template
* fix: merge error
* fix: add files in package.json
* refactor: add README to files in package.json
* fix: adjust plugins depencies
* refactor: completing plugins' devDependencies and dependencies
* fix: bug
* refactor: remove @emotion/css
* refactor: jsonwebtoken deps
* refactor: remove sequelize
* refactor: dayjs and moment deps
* fix: bugs
* fix: bug
* fix: cycle detect
* fix: merge bug
* feat: new plugin bug
* fix: lang bug
* fix: dynamic import bug
* refactor: plugins and example add father config
* feat: improve code
* fix: add AppSpin and AppError components
* Revert "refactor: plugins and example add father config"
This reverts commit 483315bca5
.
# Conflicts:
# packages/plugins/auth/package.json
# packages/plugins/multi-app-manager/package.json
# packages/samples/command/package.json
# packages/samples/custom-collection-template/package.json
# packages/samples/ratelimit/package.json
# packages/samples/shop-actions/package.json
# packages/samples/shop-events/package.json
# packages/samples/shop-modeling/package.json
* feat: update doc
---------
Co-authored-by: chenos <chenlinxh@gmail.com>
181 lines
2.5 KiB
Markdown
181 lines
2.5 KiB
Markdown
# Router
|
|
|
|
## API
|
|
|
|
### Initial
|
|
|
|
```tsx | pure
|
|
|
|
const app = new Application({
|
|
router: {
|
|
type: 'browser' // type default value is `browser`
|
|
}
|
|
})
|
|
|
|
// or
|
|
const app = new Application({
|
|
router: {
|
|
type: 'memory',
|
|
initialEntries: ['/']
|
|
}
|
|
})
|
|
```
|
|
|
|
### add Route
|
|
|
|
#### basic
|
|
|
|
```tsx | pure
|
|
import { RouteObject } from 'react-router-dom'
|
|
const app = new Application()
|
|
|
|
const Hello = () => {
|
|
return <div>Hello</div>
|
|
}
|
|
|
|
// first argument is `name` of route, second argument is `RouteObject`
|
|
app.router.add('root', {
|
|
path: '/',
|
|
element: <Hello />
|
|
})
|
|
|
|
app.router.add('root', {
|
|
path: '/',
|
|
Component: Hello
|
|
})
|
|
```
|
|
|
|
#### Component is String
|
|
|
|
```tsx | pure
|
|
app.addComponents({
|
|
Hello
|
|
})
|
|
app.router.add('root', {
|
|
path: '/',
|
|
Component: 'Hello'
|
|
})
|
|
```
|
|
|
|
#### nested
|
|
|
|
```tsx | pure
|
|
import { Outlet } from 'react-router-dom'
|
|
|
|
const Layout = () => {
|
|
return <div>
|
|
<Link to='/home'>Home</Link>
|
|
<Link to='/about'>about</Link>
|
|
|
|
<Outlet />
|
|
</div>
|
|
}
|
|
|
|
const Home = () => {
|
|
return <div>Home</div>
|
|
}
|
|
|
|
const About = () => {
|
|
return <div>About</div>
|
|
}
|
|
|
|
app.router.add('root', {
|
|
element: <Layout />
|
|
})
|
|
app.router.add('root.home', {
|
|
path: '/home',
|
|
element: <Home />
|
|
})
|
|
app.router.add('root.about', {
|
|
path: '/about',
|
|
element: <About />
|
|
})
|
|
```
|
|
|
|
It will generate the following routes:
|
|
|
|
```tsx | pure
|
|
{
|
|
element: <Layout />,
|
|
children: [
|
|
{
|
|
path: '/home',
|
|
element: <Home />
|
|
},
|
|
{
|
|
path: '/about',
|
|
element: <About />
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### remove Route
|
|
|
|
```tsx | pure
|
|
// remove route by name
|
|
app.router.remove('root.home')
|
|
app.router.remove('hello')
|
|
```
|
|
|
|
#### Router in plugin
|
|
|
|
```tsx | pure
|
|
class MyPlugin extends Plugin {
|
|
async load() {
|
|
// add route
|
|
this.app.router.add('hello', {
|
|
path: '/hello',
|
|
element: <div>hello</div>,
|
|
})
|
|
|
|
// remove route
|
|
this.app.router.remove('world');
|
|
}
|
|
}
|
|
```
|
|
|
|
## Example
|
|
|
|
```tsx
|
|
/**
|
|
* defaultShowCode: true
|
|
*/
|
|
import React from 'react';
|
|
import { Link, Outlet } from 'react-router-dom';
|
|
import { Application } from '@nocobase/client';
|
|
|
|
const Home = () => <h1>Home</h1>;
|
|
const About = () => <h1>About</h1>;
|
|
|
|
const Layout = () => {
|
|
return <div>
|
|
<div><Link to={'/'}>Home</Link>, <Link to={'/about'}>About</Link></div>
|
|
<Outlet />
|
|
</div>
|
|
}
|
|
|
|
const app = new Application({
|
|
router: {
|
|
type: 'memory',
|
|
initialEntries: ['/']
|
|
}
|
|
})
|
|
|
|
app.router.add('root', {
|
|
element: <Layout />
|
|
})
|
|
|
|
app.router.add('root.home', {
|
|
path: '/',
|
|
element: <Home />
|
|
})
|
|
|
|
app.router.add('root.about', {
|
|
path: '/about',
|
|
element: <About />
|
|
})
|
|
|
|
export default app.getRootComponent();
|
|
```
|