@modern-js/main-doc 2.1.0 → 2.3.0

package/en/tutorials/first-app/c01-start.mdx

@@ -0,0 +1,100 @@
+---
+title: Create Project
+---
+# Create Project
+
+Starting from this chapter, we will enter the practical tutorial section. In the practical tutorial, we will start with environment preparation, starting from simple to complex, building a real project step by step.
+
+## Environment preparation
+
+import Prerequisites from "@site-docs-en/components/prerequisites"
+
+<Prerequisites />
+
+## Initialization project
+
+We create a new directory and initialize the project via the command line tool:
+
+```bash
+mkdir myapp && cd myapp
+npx @modern-js/create
+```
+
+import InitApp from "@site-docs-en/components/init-app"
+
+<InitApp />
+
+## Debug Project
+
+import DebugApp from "@site-docs-en/components/debug-app"
+
+<DebugApp />
+
+## Modify the code
+
+We delete the original sample code and replace it with a simple point of contact list:
+
+```tsx title="src/routes/page.tsx"
+const getAvatar = (users: Array<{ name: string; email: string }>) =>
+  users.map(user => ({
+    ...user,
+    avatar: `https://avatars.dicebear.com/v2/identicon/${user.name}.svg`,
+  }));
+
+const mockData = getAvatar([
+  { name: 'Thomas', email: 'w.kccip@bllmfbgv.dm' },
+  { name: 'Chow', email: 'f.lfqljnlk@ywoefljhc.af' },
+  { name: 'Bradley', email: 'd.wfovsqyo@gpkcjwjgb.fr' },
+  { name: 'Davis', email: '"t.kqkoj@utlkwnpwk.nu' },
+]);
+
+function App() {
+  return (
+    <ul>
+      {mockData.map(({ name, avatar, email }) => (
+        <li key={name}>
+          <img src={avatar} width={60} height={60} /> ---
+          <span>{name}</span> ---
+          <span>{email}</span>
+        </li>
+      ))}
+    </ul>
+  );
+}
+
+export default App;
+```
+
+Remove redundant css files and keep the directory free of redundant files:
+
+```bash
+rm src/routes/index.css
+```
+
+Since the framework supports [HMR](https://webpack.js.org/concepts/hot-module-replacement/) by default, you can see that the content in http://localhost:8080/ is automatically updated to:
+
+![result](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvt/ljhwZthlaukjlkulzlp/screenshot-20221214-141909.png)
+
+The page has no styles at the moment. The next chapter will expand on this section.
+
+## Enable SSR
+
+Next, we modify the `modern.config.ts` in the project to enable the SSR capability:
+
+```ts
+import appTools, { defineConfig } from '@modern-js/app-tools';
+
+// https://modernjs.dev/docs/apis/app/config
+export default defineConfig({
+  runtime: {
+    router: true,
+    state: true,
+  },
+  server: {
+    ssr: true,
+  },
+  plugins: [appTools()],
+});
+```
+
+Re-execute `pnpm run dev` to find that the project has completed page rendering at the server level.

package/en/tutorials/first-app/c02-component.mdx

@@ -0,0 +1,59 @@
+---
+title: Add UI Components
+---
+# Add UI Components
+
+In the previous chapter, we learned how to initialize a project and use configuration to modify the default behavior of Modern.js.
+
+In this chapter, we continue to use the project code of the previous chapter and continue to improve the point of contact list.
+
+In order to do better UI display and interaction, we introduce the component library [Antd](https://ant.design/index-cn) to develop, and use the `<List>` component instead of the primitive list. Add dependency first:
+
+```bash
+pnpm add antd
+```
+
+Modify `src/routes/page.tsx` to import components at the top:
+
+```ts
+import { List } from 'antd';
+```
+
+Modify the implementation of the `<App>` component:
+
+```tsx
+function App() {
+  return (
+    <div>
+      <List
+        dataSource={mockData}
+        renderItem={({ name, email, avatar }) => (
+          <List.Item key={name}>
+            <List.Item.Meta
+              avatar={<img alt="avatar" src={avatar} width={60} height={60} />}
+              title={name}
+              description={email}
+            />
+          </List.Item>
+        )}
+      />
+    </div>
+  );
+}
+```
+
+Execute `pnpm run dev` to see the running results:
+
+![result](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/tutorials/c02-antd-result.png)
+
+You can see that the components exported by Ant Design already have complete styles.
+
+:::info note
+Modern.js [Automatically import CSS required by Ant Design component on demand](https://github.com/ant-design/babel-plugin-import).
+
+:::
+
+:::note
+We can also use other component libraries to implement the same functionality, such as [Arco Design](https://arco.design/).
+
+:::

package/en/tutorials/first-app/c03-css.mdx

@@ -0,0 +1,324 @@
+---
+title: Add Style
+---
+# Add Style
+
+import { Tabs, Tab as TabItem } from "@theme";
+
+In the previous chapter, we learned how to use components from the three-way library.
+
+In this chapter, we will learn how to implement UI components.
+
+## JS components using CSS
+
+First of all, we want to control the display of contact avatars by ourselves, and implement this design draft:
+
+![design](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/tutorials/c03-css-expect.jpg)
+
+Hypothesis has no ready-made components to implement, so you need to write some CSS yourself. Here we use [styled-components] (https://styled-components.com/) to implement similar requirements. Modern.js out of the box supports styled-components, which requires neither dependency nor configuration.
+
+Style-components avoids many problems of traditional CSS writing through modularization. For example, writing styles directly on the style attribute of elements, the visual details of UI will also be mixed with the details of UI structure and business logic. Or classname needs to avoid global space renaming, which requires the use of naming conventions.
+
+Modify the code at the top in `src/routes/page.tsx`:
+
+```js
+import styled from '@modern-js/runtime/styled';
+```
+
+Add the following code:
+
+```js
+const Avatar = styled.img`
+  width: 50px;
+  height: 50px;
+  border: 4px solid #0ef;
+  border-radius: 50%;
+`;
+```
+
+Modify the code of `List.Item.Meta`:
+
+```tsx
+<List.Item.Meta
+  avatar={<Avatar src={avatar} />}
+  title={name}
+  description={email}
+/>
+```
+
+Execute `pnpm run dev` to see the expected running result:
+
+![result](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/tutorials/c03-css-result1.png)
+
+Next we do a little refactoring. To enhance legibility and make the code easier to maintain, we can split the Avatar component. We execute the following command at the end point to create a new file:
+
+<Tabs>
+<TabItem value="macOS" label="macOS" default>
+
+```bash
+mkdir -p src/components/Avatar
+touch src/components/Avatar/index.tsx
+```
+
+</TabItem>
+<TabItem value="Windows" label="Windows">
+
+```powershell
+mkdir -p src/components/Avatar
+ni src/components/Avatar/index.tsx
+```
+
+</TabItem>
+</Tabs>
+
+Delete the `<Avatar>` implementation in `src/routes/page.tsx` and change it to:
+
+```ts
+import Avatar from '../components/Avatar';
+```
+
+The content of `src/components/Avatar/index.tsx` is modified to:
+
+```ts
+import styled from '@modern-js/runtime/styled';
+
+const Avatar = styled.img`
+  width: 50px;
+  height: 50px;
+  border: 4px solid #0ef;
+  border-radius: 50%;
+`;
+
+export default Avatar;
+```
+
+Execute `pnpm run dev`, the result should be the same.
+
+:::info note
+The reason for using the directory form `Avatar/index.tsx` instead of the single-file form `Avatar.tsx` is that you can easily add sub-files inside the directory later, including dedicated resources (pictures, etc.), dedicated sub-components, CSS files, etc.
+
+:::
+
+## Utility
+
+We have used the style-components implementation `<Avatar>` component, but the current UI is still unsatisfactory and lacks professionalism, such as the list item inhouse layout is a bit rough and misaligned in many places.
+
+Now, let's implement a better `Item` component ourselves, implementing a design draft like this:
+
+![design](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/06/design2.png)
+
+The UI to be implemented this time is more complex and has an internal structure, but on the other hand, there is no very thick bright blue border of the `<Avatar>` component such a very special UI, which is a very conventional horizontal and vertical layout, centering, font style, etc. In this case, there is actually no need to write CSS at all. There is a more efficient implementation method that complements styled-components: **Utility Class**.
+
+Modern.js integrates the mainstream, light, general-purpose Utility Class library [Tailwind CSS](https://tailwindcss.com/).
+
+Execute `pnpm run new` and select the following to start Tailwind CSS:
+
+```bash
+? Action: Enable features
+? Enable features: Enable Tailwind CSS
+```
+
+Register the Tailwind plugin in `modern.config.ts`:
+
+```ts title="modern.config.ts"
+import appTools, { defineConfig } from '@modern-js/app-tools';
+import tailwindcssPlugin from '@modern-js/plugin-tailwindcss';
+
+// https://modernjs.dev/docs/apis/app/config
+export default defineConfig({
+  runtime: {
+    router: true,
+    state: true,
+  },
+  server: {
+    ssr: true,
+  },
+  plugins: [appTools(), tailwindcssPlugin()],
+});
+```
+
+Import the Tailwind CSS css file at the top of `src/routes/page.tsx` to start a quick implementation of the professional UI:
+
+```js
+import 'tailwindcss/base.css';
+import 'tailwindcss/components.css';
+import 'tailwindcss/utilities.css';
+```
+
+Create the Item component first:
+
+<Tabs>
+<TabItem value="macOS" label="macOS" default>
+
+```bash
+mkdir -p src/components/Item
+touch src/components/Item/index.tsx
+```
+
+</TabItem>
+<TabItem value="Windows" label="Windows">
+
+```powershell
+mkdir -p src/components/Item
+ni src/components/Item/index.tsx
+```
+
+</TabItem>
+</Tabs>
+
+Modify `src/routes/page.tsx` to pass the `render` implementation of `List` to `Item` component:
+
+```js
+import { List } from 'antd';
+import 'tailwindcss/base.css';
+import 'tailwindcss/components.css';
+import 'tailwindcss/utilities.css';
+import Item from '../components/Item';
+
+const getAvatar = (users: Array<{ name: string, email: string }>) =>
+  users.map(user => ({
+    ...user,
+    avatar: `https://avatars.dicebear.com/v2/identicon/${user.name}.svg`,
+  }));
+
+const mockData = getAvatar([
+  { name: 'Thomas', email: 'w.kccip@bllmfbgv.dm' },
+  { name: 'Chow', email: 'f.lfqljnlk@ywoefljhc.af' },
+  { name: 'Bradley', email: 'd.wfovsqyo@gpkcjwjgb.fr' },
+  { name: 'Davis', email: '"t.kqkoj@utlkwnpwk.nu' },
+]);
+
+function Index() {
+  return (
+    <div className="container lg mx-auto">
+      <List
+        dataSource={mockData}
+        renderItem={info => <Item key={info.name} info={info} />}
+      />
+    </div>
+  );
+}
+
+export default Index;
+```
+
+Utility Class(https://tailwindcss.com/docs/container) is used on the parent container for a quick implementation of the most basic maximum width, center, and other styles.
+
+Next implementation `src/components/Item/index.tsx`:
+
+```tsx
+import Avatar from '../Avatar';
+
+type InfoProps = {
+  avatar: string;
+  name: string;
+  email: string;
+  archived?: boolean;
+};
+
+const Item = ({ info }: { info: InfoProps }) => {
+  const { avatar, name, email, archived } = info;
+  return (
+    <div className="flex p-4 items-center border-gray-200 border-b">
+      <Avatar src={avatar} />
+      <div className="ml-4 flex-1 flex justify-between">
+        <div className="flex-1">
+          <p>{name}</p>
+          <p>{email}</p>
+        </div>
+        <button
+          type="button"
+          disabled={archived}
+          className={`bg-blue-500  text-white font-bold
+            py-2 px-4 rounded-full hover:bg-blue-700`}
+        >
+          Archive
+        </button>
+      </div>
+    </div>
+  );
+};
+
+export default Item;
+```
+
+Execute `pnpm run dev` to see the expected running result:
+
+![result](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/06/result2.png)
+
+We only use a few Utility Classes, such as [Flex](https://tailwindcss.com/docs/display/), [Padding](https://tailwindcss.com/docs/padding/), [Margin](https://tailwindcss.com/docs/margin/), [Text](https://tailwindcss.com/docs/text-color/), [Font](https://tailwindcss.com/docs/font-weight/), [Border](https://tailwindcss.com/docs/border-width), without writing a single CSS implementation Professional UI that conforms to the design draft.
+
+## Customized Utility Class
+
+We can also implement the new Utility Class ourselves to facilitate reuse between codes.
+
+Utility Class itself is also a **component-oriented** technology (using different classes on a component is equivalent to setting some attributes from the base class for this component), but the classname of Utility Class is global (because it is used on arbitrary components/elements), it is very suitable for implementation with separate CSS files.
+
+Create a new CSS file:
+
+<Tabs>
+<TabItem value="macOS" label="macOS" default>
+
+```bash
+mkdir -p src/styles
+touch src/styles/utils.css
+```
+
+</TabItem>
+<TabItem value="Windows" label="Windows">
+
+```powershell
+mkdir -p src/styles
+ni src/styles/utils.css
+```
+
+</TabItem>
+</Tabs>
+
+在 `src/routes/page.tsx` 里导入 `utils.css`：
+
+```js
+import '../styles/utils.css';
+```
+
+A Utility Class named `custom-text-gray` is implemented in `src/routes/styles/utils.css`.
+
+```css
+:root {
+  --custom-text-color: rgb(113, 128, 150);
+}
+
+.custom-text-gray {
+  color: var(--custom-text-color);
+}
+```
+
+:::info note
+Modern.js integrates with [PostCSS](/guides/basic-features/css/postcss) and supports modern CSS syntax features such as [custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties).
+
+:::
+
+Use in `src/routes/components/Item/index.tsx`:
+
+```js
+<div className="ml-4 flex-1 flex justify-between">
+```
+
+Change to:
+
+```js
+<div className="ml-4 custom-text-gray flex-1 flex justify-between">
+```
+
+Execute `pnpm run dev`, you can see that the font color has changed:
+
+![design2](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/06/result3.png)
+
+:::info note
+This is just to demonstrate Utility Class usage. In a real project, with Tailwind CSS, this Utility Class is of little value and should be added to the font color through the [**theme**](https://tailwindcss.com/docs/customizing-colors) of the configuration Design System.
+
+`utils.css` can also be written as `utils.scss` or `utils.less`, Modern.js out of the box support for SCSS and Less.
+
+However, with the support of PostCSS, modern CSS should be sufficient to meet these development needs, and the performance is also better than that of the preprocessor. It is recommended to use `.css` files first.
+
+:::

package/en/tutorials/first-app/c04-routes.mdx

@@ -0,0 +1,170 @@
+---
+title: Add Client Route
+---
+# Add Client Route
+
+import { Tabs, Tab as TabItem } from "@theme";
+
+In the previous chapter, we learned how to create UI components and add styles.
+
+In this chapter, we will learn how to add **Client Route**.
+
+Previously we have added the Archive button to the point of contact list, next we add a route `/archives`, when accessing this route, only the point of contact of the saved file is displayed, while the original `/` continues to display all points of contact.
+
+Create a new `src/routes/archives/page.tsx` file:
+
+<Tabs>
+<TabItem value="macOS" label="macOS" default>
+
+```bash
+mkdir -p src/routes/archives
+touch src/routes/archives/page.tsx
+```
+
+</TabItem>
+<TabItem value="Windows" label="Windows">
+
+```powershell
+mkdir -p src/routes/archives
+ni src/routes/archives/page.tsx
+```
+
+</TabItem>
+</Tabs>
+
+Add the following code:
+
+```tsx title="src/archives/page.tsx"
+import { List } from 'antd';
+import { Helmet } from '@modern-js/runtime/head';
+import Item from '../../components/Item';
+
+const getAvatar = (users: Array<{ name: string; email: string }>) =>
+  users.map(user => ({
+    ...user,
+    avatar: `https://avatars.dicebear.com/v2/identicon/${user.name}.svg`,
+  }));
+
+const getMockArchivedData = () =>
+  getAvatar([
+    { name: 'Thomas', email: 'w.kccip@bllmfbgv.dm' },
+    { name: 'Chow', email: 'f.lfqljnlk@ywoefljhc.af' },
+  ]);
+function Index() {
+  return (
+    <div className="container lg mx-auto">
+      <Helmet>
+        <title>Archives</title>
+      </Helmet>
+      <List
+        dataSource={getMockArchivedData()}
+        renderItem={info => <Item key={info.name} info={info} />}
+      />
+    </div>
+  );
+}
+
+export default Index;
+```
+
+The `Helmet` component of [React Helmet](https://github.com/nfl/react-helmet) is used here, and the Helmet component is also added in `src/routes/page.tsx`:
+
+```tsx
+import { Helmet } from '@modern-js/runtime/head';
+
+function Index() {
+  return (
+    <div className="container lg mx-auto">
+      <Helmet>
+        <title>All</title>
+      </Helmet>
+      ...
+    </div>
+  );
+}
+```
+
+:::info note
+Modern.js integrates react-helmet by default, and can also be used in conjunction with SSR to meet SEO needs.
+
+:::
+
+Since there are multiple pages now, all of which need to use the previous Utility Class, we need to move the style file to `src/routes/layout.tsx`:
+
+```tsx
+import 'tailwindcss/base.css';
+import 'tailwindcss/components.css';
+import 'tailwindcss/utilities.css';
+import '../styles/utils.css';
+```
+
+Execute `pnpm run dev`, visit `http://localhost:8080`, you can see the full point of contact, the title of the page is All:
+
+![display1](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/tutorials/c04-archives.png)
+
+Visit `http://localhost:8080/archives` and you will only see the point of contact of the saved file with the title Archives:
+
+![display](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/tutorials/c04-all.png)
+
+Looking at the HTML source code of the page, you can see that the content of the two pages is the same, and different content is rendered for different URLs.
+
+**Next we add a simple navigation bar that allows the user to toggle between the two lists**.
+
+Open `src/routes/layout.tsx` and import the Radio component at the top:
+
+```tsx
+import { Radio } from 'antd';
+```
+
+Then modify the top of the UI to add a set of radio group:
+
+```tsx {4-9}
+export default function Layout() {
+  return (
+    <div>
+      <div className="h-16 p-2 flex items-center justify-center">
+        <Radio.Group onChange={handleSetList} value={currentList}>
+          <Radio value="/">All</Radio>
+          <Radio value="/archives">Archives</Radio>
+        </Radio.Group>
+      </div>
+      <Outlet />
+    </div>
+  );
+}
+```
+
+Then we come to the implementation of `currentList` and `handleSetList`.
+
+Introducing three React Hooks: `useState` and `useNavigate` and `useParams`, as well as Ant Design's event type definition:
+
+```js
+import { useState } from 'react';
+import { Radio, RadioChangeEvent } from 'antd';
+import { Outlet, useLocation, useNavigate } from '@modern-js/runtime/router';
+```
+
+Finally, add local state and related logic to the Layout component:
+
+```tsx {2-9}
+export default function Layout() {
+  const navigate = useNavigate();
+  const location = useLocation();
+  const [currentList, setList] = useState(location.pathname || '/');
+  const handleSetList = (e: RadioChangeEvent) => {
+    const { value } = e.target;
+    setList(value);
+    navigate(value);
+  };
+  return (
+  ...
+}
+```
+
+At this point, the page navigation bar implementation has been completed, and execute `pnpm run dev` to see the effect:
+
+![display2](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/tutorials/c04-switch.png)
+
+Click Archives in the navigation bar, you can see that the selected state and URL of the radio box will change, the page is not refreshed, only CSR occurs.
+
+Accessing the two pages through the URL, you can see that the HTML content is different, because the page executes the logic of client routing in the SSR stage, and the HTML already contains the final render result.