Skip to content

Commit 4a0a26a

Browse files
committed
renamings
1 parent bef0f00 commit 4a0a26a

File tree

24 files changed

+89
-111
lines changed

24 files changed

+89
-111
lines changed

.github/workflows/examples.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
path:
2121
- nextjs-app
2222
- nextjs-pages
23-
- remix-ts
23+
- react-router-ts
2424
- vite-ts
2525
fail-fast: false
2626
steps:
Lines changed: 23 additions & 0 deletions
Loading

.storybook/images/logo-remix.svg

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/ProjectTemplates.mdx

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import { Footer, ProjectTemplate, TableOfContent, LabelWithWrapping } from '@sb/components';
2-
import { Meta } from '@storybook/blocks';
3-
import { Link, FlexBox, FlexBoxJustifyContent, FlexBoxWrap, Label } from '@ui5/webcomponents-react';
1+
import { Footer, LabelWithWrapping, ProjectTemplate, TableOfContent } from '@sb/components';
42
import NextLogo from '@sb/images/logo-nextjs.svg';
3+
import ReactRouterLogo from '@sb/images/logo-react-router.svg';
54
import ViteLogo from '@sb/images/logo-vitejs.svg';
6-
import RemixLogo from '@sb/images/logo-remix.svg';
5+
import { Meta } from '@storybook/blocks';
6+
import { FlexBox, FlexBoxJustifyContent, FlexBoxWrap, Label } from '@ui5/webcomponents-react';
77

88
<Meta title="Project Templates & Examples" />
99

@@ -98,7 +98,9 @@ A curated list of minimal project templates and examples to get started using UI
9898
>
9999
<ul>
100100
<li>
101-
<LabelWithWrapping>Routing and Data Fetching using the createBrowserRouter of React Router</LabelWithWrapping>
101+
<LabelWithWrapping>
102+
Routing and Data Fetching using the <code>createBrowserRouter</code> of React Router
103+
</LabelWithWrapping>
102104
</li>
103105
<li>
104106
<Label>Cypress Component Test setup</Label>
@@ -112,17 +114,16 @@ A curated list of minimal project templates and examples to get started using UI
112114
</ul>
113115
</ProjectTemplate>
114116
<ProjectTemplate
115-
title={'Remix'}
116-
logo={RemixLogo}
117-
logoAttribution={'Remix.run Logo. Original Source: https://remix.run'}
118-
href={'https://github.com/SAP/ui5-webcomponents-react/tree/main/examples/remix-ts'}
117+
title={'React Router v7'}
118+
subtitle={'Previously: Remix Template'}
119+
logo={ReactRouterLogo}
120+
logoAttribution={'React Router Logo. Original Source: https://reactrouter.com'}
121+
href={'https://github.com/SAP/ui5-webcomponents-react/tree/main/examples/react-router-ts'}
119122
isTypeScript
120123
>
121124
<ul>
122125
<li>
123-
<Label>
124-
Remix template using <code>remix-island</code>
125-
</Label>
126+
<Label>{`React Router v7 with server side rendering`}</Label>
126127
</li>
127128
<li>
128129
<Label>Theming</Label>

examples/react-router-ts/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# UI5 Web Components React - React Router Example
2+
3+
This example shows how to use the [React Router](https://reactrouter.com/) with UI5 Web Components for React.
4+
This example was previously known as [Remix](https://remix.run/), and got updated to use React Router v7.
5+
6+
## How to use this template
7+
8+
```bash
9+
npx degit SAP/ui5-webcomponents-react/examples/react-router-ts#main my-project
10+
cd my-project
11+
```
12+
13+
## Getting Started
14+
15+
First, install the node_modules:
16+
17+
```bash
18+
npm install
19+
```
20+
21+
Then, run the development server:
22+
23+
```bash
24+
npm run dev
25+
```
26+
27+
## Deployment
28+
29+
First, build your app for production:
30+
31+
```sh
32+
npm run build
33+
```
34+
35+
Then run the app in production mode:
36+
37+
```sh
38+
npm start
39+
```
40+
41+
Now you'll need to pick a host to deploy it to.
42+
43+
## Learn More
44+
45+
- 📖 See the [React router docs](https://reactrouter.com/home).
File renamed without changes.

examples/remix-ts/app/components/AppShellBar.module.css renamed to examples/react-router-ts/app/components/AppShellBar.module.css

File renamed without changes.

examples/remix-ts/app/components/AppShellBar.tsx renamed to examples/react-router-ts/app/components/AppShellBar.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export function AppShellBar() {
4646
<>
4747
<ShellBar
4848
primaryTitle={'UI5 Web Components for React Examples'}
49-
secondaryTitle={'Remix.run App'}
49+
secondaryTitle={'React Router Example'}
5050
startButton={
5151
pathname !== '/' && (
5252
<Button
File renamed without changes.

0 commit comments

Comments
 (0)