Skip to content

Commit

Permalink
feat: versions query (#65)
Browse files Browse the repository at this point in the history
> 对 versions 页面添加 tags、versions query 参数, closes #63 
* 添加 `useQueryState` hook,同步 state 和 query 参数
* 支持 {prod, all},默认为 prod 且隐藏对应参数
  • Loading branch information
elrrrrrrr authored Dec 18, 2023
1 parent 247480c commit 6af3476
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 4 deletions.
64 changes: 64 additions & 0 deletions src/hooks/useQueryState.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
import { useState, useEffect } from 'react';
import { useRouter } from 'next/router';

type QueryValue = string | boolean | number;

function useQueryState<T extends QueryValue>(
key: string,
defaultValue: T,
ignoreValues: QueryValue[] = []
): [T, (newValue: T) => void] {
const router = useRouter();
const [state, setState] = useState<T>(() => {
const valueFromQuery = router.isReady ? router.query[key] : undefined;
return parseValue(valueFromQuery, defaultValue);
});

useEffect(() => {
if (!router.isReady) return;
const valueFromQuery = router.query[key];
setState(parseValue(valueFromQuery, defaultValue));
}, [router.isReady, router.query, key, defaultValue]);

useEffect(() => {
const handleRouteChange = () => {
const valueFromQuery = router.query[key];
setState(parseValue(valueFromQuery, defaultValue));
};

router.events.on('routeChangeComplete', handleRouteChange);
return () => {
router.events.off('routeChangeComplete', handleRouteChange);
};
}, [router.events, key, defaultValue]);

const setQueryState = (newValue: T) => {
const newQuery = { ...router.query };

if (ignoreValues.includes(newValue) || newValue === defaultValue) {
delete newQuery[key];
} else {
newQuery[key] = stringifyValue(newValue) as string;
}

router.push({ pathname: router.pathname, query: newQuery }, undefined, { shallow: true });
setState(newValue);
};

return [state, setQueryState];
}

function parseValue<T extends QueryValue>(value: string | string[] | undefined, defaultValue: T): T {
if (value === undefined || Array.isArray(value)) return defaultValue;
if (value === 'true') return true as T;
if (value === 'false') return false as T;
if (!isNaN(Number(value))) return Number(value) as T;
return value as unknown as T;
}

function stringifyValue(value: QueryValue): string {
if (typeof value === 'boolean' || typeof value === 'number') return String(value);
return value as string;
}

export default useQueryState;
13 changes: 9 additions & 4 deletions src/slugs/versions/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import SyncAlert from '@/components/SyncAlert';
import { PageProps } from '@/pages/package/[...slug]';
import { createStyles } from 'antd-style';
import VersionTags from '@/components/VersionTags';
import useQueryState from '@/hooks/useQueryState';

const useStyles = createStyles(({ token, css }) => {
return {
Expand Down Expand Up @@ -47,7 +48,8 @@ const useStyles = createStyles(({ token, css }) => {

function TagsList({ tagsInfo, pkg }: { tagsInfo: Record<string, string[]>; pkg: PackageManifest }) {
const { styles } = useStyles();
const [onlyProd, setOnlyProd] = React.useState(true);
const [type, setTags] = useQueryState<string>('tags', 'prod', ['prod']);
const onlyProd = type === 'prod';
return (
<div style={{ position: 'relative' }}>
<Typography.Title
Expand All @@ -69,11 +71,12 @@ function TagsList({ tagsInfo, pkg }: { tagsInfo: Record<string, string[]>; pkg:
}}
>
<Segmented
defaultValue={type}
options={[
{ label: '正式版本', value: 'prod' },
{ label: '所有版本', value: 'all' },
]}
onChange={(v) => setOnlyProd(v === 'prod')}
onChange={(v) => setTags(v as string)}
/>
</Space>
<ul className={styles.versionsCon}>
Expand Down Expand Up @@ -105,7 +108,8 @@ function TagsList({ tagsInfo, pkg }: { tagsInfo: Record<string, string[]>; pkg:

function VersionsList({ versions, pkg }: { versions: NpmPackageVersion[]; pkg: PackageManifest }) {
const { styles } = useStyles();
const [onlyProd, setOnlyProd] = React.useState(true);
const [type, setVersions] = useQueryState<string>('versions', 'prod', ['prod']);
const onlyProd = type === 'prod';
return (
<div style={{ position: 'relative' }}>
<Typography.Title
Expand All @@ -127,11 +131,12 @@ function VersionsList({ versions, pkg }: { versions: NpmPackageVersion[]; pkg: P
}}
>
<Segmented
defaultValue={type}
options={[
{ label: '正式版本', value: 'prod' },
{ label: '所有版本', value: 'all' },
]}
onChange={(v) => setOnlyProd(v === 'prod')}
onChange={(v) => setVersions(v as string)}
/>
</Space>
<ul className={styles.versionsCon}>
Expand Down

0 comments on commit 6af3476

Please sign in to comment.