From fd72ee2956efb7b7dd49c719c606204c4754a0ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ya=C3=ABl=20GUILLOUX?= Date: Wed, 25 Jan 2023 02:44:02 +0100 Subject: [PATCH] chore(schema): update schema --- components/docs/DocsAsideTree.vue | 12 ++++----- nuxt.schema.ts | 42 +++++++++++++++---------------- tokens.config.ts | 2 +- 3 files changed, 27 insertions(+), 29 deletions(-) diff --git a/components/docs/DocsAsideTree.vue b/components/docs/DocsAsideTree.vue index 11b2dc1fc..74c18e2d4 100644 --- a/components/docs/DocsAsideTree.vue +++ b/components/docs/DocsAsideTree.vue @@ -27,7 +27,7 @@ const collapsedMap = useState(`docus-docs-aside-collapse-map-${props.parent?._pa if (props.level === 0) { return {} } - return props.links + return (props.links as any []) .filter(link => !!link.children) .reduce((map, link) => { map[link._path] = true @@ -35,11 +35,11 @@ const collapsedMap = useState(`docus-docs-aside-collapse-map-${props.parent?._pa }, {}) }) -const isActive = (link) => { +const isActive = (link: any) => { return route.path === link._path } -const isCollapsed = (link) => { +const isCollapsed = (link: any) => { if (link.children) { // Directory has been toggled manually, use its state if (typeof collapsedMap.value[link._path] !== 'undefined') { @@ -49,15 +49,13 @@ const isCollapsed = (link) => { // Return value grabbed from the link if (link?.collapsed) { return link?.collapsed } - if (docus.value.aside?.collapsed) { return docus.value.aside?.collapsed } + if (docus?.value?.aside?.collapsed) { return docus.value.aside?.collapsed } } return false } -const toggleCollapse = (link) => { - collapsedMap.value[link._path] = !isCollapsed(link) -} +const toggleCollapse = (link: any) => (collapsedMap.value[link._path] = !isCollapsed(link)) const hasNesting = computed(() => props.links.some((link: any) => link.children)) diff --git a/nuxt.schema.ts b/nuxt.schema.ts index 880efc2ab..89bd92c3e 100644 --- a/nuxt.schema.ts +++ b/nuxt.schema.ts @@ -3,19 +3,19 @@ export default defineNuxtConfigSchema({ /** * Docus theme configuration. * - * @studio-icon material-symbols:docs + * @studioIcon material-symbols:docs */ docus: { /** * Website title, used as header default title and meta title. * - * @studio-icon material-symbols:title + * @studioIcon material-symbols:title */ title: 'Docus', /** * Website description, used for meta description. * - * @studio-icon material-symbols:description + * @studioIcon material-symbols:description */ description: 'The best place to start your documentation.', /** @@ -23,8 +23,8 @@ export default defineNuxtConfigSchema({ * * @example '/cover.jpg' * - * @studio-icon dashicons:cover-image - * @studio-input file + * @studioIcon dashicons:cover-image + * @studioInput file */ image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png', /** @@ -32,50 +32,50 @@ export default defineNuxtConfigSchema({ * * Will be used in AppSocialIcons component. * - * @studio-icon material-symbols:share-outline + * @studioIcon material-symbols:share-outline */ socials: { /** * Twitter social handle * @example 'nuxt_js' - * @studio-icon simple-icons:twitter + * @studioIcon simple-icons:twitter */ twitter: '', /** * GitHub org or repository * @example 'nuxt/framework' - * @studio-icon simple-icons:github + * @studioIcon simple-icons:github */ github: '', /** * Facebook page url * @example https://www.facebook.com/groups/nuxtjs - * @studio-icon simple-icons:facebook + * @studioIcon simple-icons:facebook */ facebook: '', /** * Instagram page url * @example https://www.instagram.com/wearenuxt - * @studio-icon simple-icons:instagram + * @studioIcon simple-icons:instagram */ instagram: '', /** * Instagram page url * @example https://www.youtube.com/@NuxtLabs - * @studio-icon simple-icons:youtube + * @studioIcon simple-icons:youtube */ youtube: '', /** * Medium page url * @example https://medium.com/nuxt - * @studio-icon simple-icons:medium + * @studioIcon simple-icons:medium */ medium: '' }, /** * Theme layout configuration. * - * @studio-icon tabler:arrow-autofit-width + * @studioIcon tabler:arrow-autofit-width */ layout: { /** @@ -86,7 +86,7 @@ export default defineNuxtConfigSchema({ /** * Aside navigation configuration. * - * @studio-icon fluent:document-page-24-regular + * @studioIcon fluent:document-page-24-regular */ aside: { /** @@ -110,7 +110,7 @@ export default defineNuxtConfigSchema({ /** * Header configuration. * - * @studio-icon fluent:document-header-24-regular + * @studioIcon fluent:document-header-24-regular */ header: { /** @@ -120,7 +120,7 @@ export default defineNuxtConfigSchema({ * * Default to docus.title * - * @studio-icon material-symbols:title + * @studioIcon material-symbols:title */ title: '', /** @@ -131,7 +131,7 @@ export default defineNuxtConfigSchema({ * String to be used as a name of a component. * * @example 'MyLogo' - * @studio-input component + * @studioInput boolean */ logo: false, /** @@ -151,7 +151,7 @@ export default defineNuxtConfigSchema({ /** * Footer configuration * - * @studio-icon fluent:document-footer-24-regular + * @studioIcon fluent:document-footer-24-regular */ footer: { /** @@ -159,7 +159,7 @@ export default defineNuxtConfigSchema({ * * @type {false|object} * - * @studio-icon material-symbols:copyright + * @studioIcon material-symbols:copyright */ credits: { /** @@ -175,7 +175,7 @@ export default defineNuxtConfigSchema({ * * Will be added into center section of the footer. * - * @studio-icon material-symbols:add-link + * @studioIcon material-symbols:add-link */ textLinks: { $schema: { @@ -199,7 +199,7 @@ export default defineNuxtConfigSchema({ * * Icons to be added to Social Icons in footer. * - * @studio-icon material-symbols:add-link + * @studioIcon material-symbols:add-link */ iconLinks: { $schema: { diff --git a/tokens.config.ts b/tokens.config.ts index 6ec618da3..f98e93d65 100644 --- a/tokens.config.ts +++ b/tokens.config.ts @@ -9,7 +9,7 @@ export default defineTheme({ $schema: { title: 'All the configurable tokens from Docus.', tags: [ - '@studio-icon material-symbols:docs' + '@studioIcon material-symbols:docs' ] }, header: { height: '64px' },