Files
frontend/docs/src/en/guide/in-depth/features.md
invalid w 8230493651 feat(@vben/docs): support english documents (#4202)
* chore(@vben/docs): 完成guide文档的翻译

* chore(@vben/docs): 完成other文档的翻译

* chore: 翻译部分文档

* chore: 完成英文config的配置

* chore: 完成in-depth的文档翻译

* chore: 调整调整链接

* chore: typo

* chore: typo

* chore: update links

---------

Co-authored-by: Li Kui <90845831+likui628@users.noreply.github.com>
2024-08-23 19:46:51 +08:00

2.0 KiB

Common Features

A collection of some commonly used features.

Login Authentication Expiry

When the interface returns a 401 status code, the framework will consider the login authentication to have expired. Upon login timeout, it will redirect to the login page or open a login popup. This can be configured in preferences.ts in the application directory:

Redirect to Login Page

Upon login timeout, it will redirect to the login page.

import { defineOverridesPreferences } from '@vben/preferences';

export const overridesPreferences = defineOverridesPreferences({
  // overrides
  app: {
    loginExpiredMode: 'page',
  },
});

Open Login Popup

When login times out, a login popup will open.

login-expired

Configuration:

import { defineOverridesPreferences } from '@vben/preferences';

export const overridesPreferences = defineOverridesPreferences({
  // overrides
  app: {
    loginExpiredMode: 'model',
  },
});

Dynamic Title

  • Default value: true

When enabled, the webpage title changes according to the route's title. You can enable or disable this in the preferences.ts file in your application directory.

export const overridesPreferences = defineOverridesPreferences({
  // overrides
  app: {
    dynamicTitle: true,
  },
});

Page Watermark

  • Default value: false

When enabled, the webpage will display a watermark. You can enable or disable this in the preferences.ts file in your application directory.

export const overridesPreferences = defineOverridesPreferences({
  // overrides
  app: {
    watermark: true,
  },
});

If you want to update the content of the watermark, you can do so. The parameters can be referred to watermark-js-plus:

import { useWatermark } from '@vben/hooks';

const { destroyWatermark, updateWatermark } = useWatermark();

await updateWatermark({
  // watermark content
  content: 'hello my watermark',
});