Skip to content

Update README.md #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tolking merged 3 commits into from
Aug 17, 2026
Merged

Update README.md #181

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d7d03d
Update README.md
FrontEndDog Aug 13, 2026
a46229f
update readme
FrontEndDog Aug 14, 2026
c883f54
Update README.md
FrontEndDog Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 25 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,35 @@

## Installation

> [!WARNING]
> Since the [dayjs](https://github.com/iamkun/dayjs) used internally by element-plus is not a [JavaScript modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules), in order to ensure that it can be converted into a JavaScript modules before startup, you need to add a `.npmrc` file to the root directory of the project and add the following configuration:
> ```
> shamefully-hoist=true
> node-linker=hoisted
> ```
> Or install the `dayjs` dependency separately.

```bash
npx nuxi@latest module add element-plus
# or
npm i element-plus @element-plus/nuxt -D
```

> [!WARNING]
> If you are using `pnpm`, please note that the [dayjs](https://github.com/iamkun/dayjs) package used internally by Element Plus is not a [JavaScript modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules).
> In order to ensure that it can be converted into a JavaScript modules before startup, you need to configure pnpm to hoist dependencies.
> For pnpm 10.5.x and earlier, add the following configuration to a `.npmrc` file in the project root:
>
> ```ini
> shamefully-hoist=true
> node-linker=hoisted
> ```
>
> For pnpm 10.6.x and later, add the following configuration to `pnpm-workspace.yaml`:
>
> ```yaml
> shamefullyHoist: true
> nodeLinker: hoisted
> ```
>
> Alternatively, you can install the dayjs dependency explicitly in your project:
>
> ```bash
> pnpm add dayjs
> ```

## Configuration

> [!WARNING]
Expand Down Expand Up @@ -117,7 +132,7 @@ e.g. `'zh-cn'`
- Type: `boolean`
- Default: `false`

Whether to cache the element-plus components and directives. **Only effective in development mode**.
Whether to cache the Element Plus components and directives. **Only effective in development mode**.

If you enable this feature, you will get faster loading speed in development mode.

Expand Down Expand Up @@ -196,7 +211,7 @@ If there are directives that are not imported automatically from Element Plus, y

If you wish to add automatically import content from Element Plus, you can add it here.

e.g.
e.g.

```ts
[
Expand Down
Loading