Skip to content
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.

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

Add support for dynamic change favicon and title #44

Merged
merged 2 commits into from
Jan 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "minor",
"comment": "add support for config title and favicon",
"packageName": "@zhishuyun/hub",
"email": "[email protected]",
"dependentChangeType": "patch"
}
20 changes: 0 additions & 20 deletions hub.config.js

This file was deleted.

3 changes: 1 addition & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" href="/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>知数云 - 数字化服务的智慧之选</title>
<title></title>
</head>
<body>
<div id="app"></div>
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@
"sass": "^1.38.1",
"tailwindcss": "^3.4.0",
"typescript": "^4.9.5",
"unplugin-element-plus": "^0.8.0",
"vite": "^2.9.16",
"vite-bundle-visualizer": "^1.0.0",
"vue-tsc": "^1.2.0"
Expand Down
File renamed without changes.
32 changes: 31 additions & 1 deletion src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,32 @@ export default {
/**
* The global configuration.
*/
global: {},
global: {
/**
* Title of the app.
* You can change it by your own.
*/
title: '知数云 - 数字化服务的智慧之选',

/**
* Logo url of the app.
* If provided which starts with http/https prefix, will be used.
* If not provided, will by default use @/assets/images/logo.svg as instead, you can replace it.
*/
logoUrl: undefined,

/**
* Favicon url of the app.
* If provided which starts with http/https prefix, will be used.
* If not provided, will by default use @/assets/images/favicon.ico as instead, you can replace it.
*/
faviconUrl: undefined,

/**
* The default language of the app, enum as 'zh-cn', 'en'.
*/
language: 'zh-cn'
},

/**
* The left navigation configuration.
Expand Down Expand Up @@ -64,6 +89,11 @@ export default {
* The auth configuration.
*/
auth: {
/**
* The default auth provider, enum as 'wechat', 'email', 'phone'.
*/
defaultProvider: 'wechat',

/**
* The auth provider configuration.
*/
Expand Down
4 changes: 3 additions & 1 deletion src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ import { vLoading } from 'element-plus';
import hl from 'highlight.js';
import 'highlight.js/styles/night-owl.css';
import copyToClipboard from 'copy-to-clipboard';
import { initializeCookies } from './utils/initializer';
import { initializeCookies, initializeFavicon, initializeTitle } from './utils/initializer';
import config from './plugins/config';

initializeCookies();
initializeTitle();
initializeFavicon();

const app = createApp(App);

Expand Down
36 changes: 36 additions & 0 deletions src/utils/initializer.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import { setCookie } from 'typescript-cookie';
import config from '@/config';
import favicon from '@/assets/images/favicon.ico';

/**
* Initialize cookies.
*/
export const initializeCookies = () => {
// parse the query string and set to cookies
const query = new URLSearchParams(window.location.search);
Expand All @@ -15,3 +20,34 @@ export const initializeCookies = () => {
});
}
};

/**
* Initialize title.
*/
export const initializeTitle = () => {
// set the title from config.global.title
const title = config.global.title;
// find the title element or insert a new one
let titleElement = document.querySelector('title');
if (!titleElement) {
titleElement = document.createElement('title');
document.head.appendChild(titleElement);
}
titleElement.innerHTML = title;
};

/**
* Initialize favicon.
*/
export const initializeFavicon = () => {
// by default use favicon which imported
// if faviconUrl is set in config, use it instead
const favIconUrl = config.global.faviconUrl;
let faviconElement = document.querySelector('link[rel="icon"]') as HTMLLinkElement;
if (!faviconElement) {
faviconElement = document.createElement('link');
faviconElement.rel = 'icon';
document.head.appendChild(faviconElement);
}
faviconElement.href = favIconUrl || favicon;
};