chore(typescript): renamed types

Author: ThornWalli

docs/src/composables/use-content-container.md

@@ -35,7 +35,7 @@ const { currentTag } = useContentContainer();
 ## Options
 
 ```ts
-type Options = {
+type ContentContainerOptions = {
   tag?: string | undefined;
   contentTags?: Array<string>;
   rootTags?: Array<string>;
@@ -53,7 +53,7 @@ type Options = {
 ## Return
 
 ```ts
-type Return = {
+type ContentContainerReturn = {
   parentLevel: ComputedRef<number>;
   currentLevel: ComputedRef<number>;
   currentTag: ComputedRef<string>;

docs/src/composables/use-content-headline.md

@@ -36,7 +36,7 @@ const { currentTag } = useContentHeadline();
 ## Options
 
 ```ts
-type Options = {
+type ContentHeadlineOptions = {
   tag?: string | undefined;
 };
 ```
@@ -48,7 +48,7 @@ type Options = {
 ## Return
 
 ```ts
-type Return = {
+type ContentHeadlineReturn = {
   parentLevel: ComputedRef<number>;
   currentLevel: ComputedRef<number>;
   currentTag: ComputedRef<string>;

src/useContentContainer.ts

@@ -1,19 +1,24 @@
 import { provide, inject, computed, type ComputedRef } from 'vue';
 
-export type Options = {
+export type ContentContainerOptions = {
   tag?: string | undefined;
   rootTags?: string[];
   contentTags?: string[];
   level?: number;
 };
 
-export type Result = {
+export type ContentContainerResult = {
   parentLevel: ComputedRef<number>;
   currentLevel: ComputedRef<number>;
   currentTag: ComputedRef<string>;
 };
 
-export default function useContentContainer({ tag, contentTags, rootTags, level }: Options = {}): Result {
+export default function useContentContainer({
+  tag,
+  contentTags,
+  rootTags,
+  level
+}: ContentContainerOptions = {}): ContentContainerResult {
   tag = tag || undefined;
   rootTags = rootTags || inject('semanticStructure_rootTags', ['main']);
   contentTags = contentTags || inject('semanticStructure_contentTags', ['article', 'section']);

src/useContentHeadline.ts

@@ -1,16 +1,16 @@
 import { inject, computed, type ComputedRef } from 'vue';
 
-export type Options = {
+export type ContentHeadlineOptions = {
   tag?: string | undefined;
 };
 
-export type Return = {
+export type ContentHeadlineReturn = {
   parentLevel: ComputedRef<number>;
   currentLevel: ComputedRef<number>;
   currentTag: ComputedRef<string>;
 };
 
-export default function useContentHeadline({ tag }: Options = {}): Return {
+export default function useContentHeadline({ tag }: ContentHeadlineOptions = {}): ContentHeadlineReturn {
   const parentLevel = computed(() => inject('semanticStructure_parentLevel', 1) + 1);
   const rootLevel = inject('semanticStructure_rootLevel', 1);
 

test/useContentHeadline.test.ts

@@ -15,10 +15,10 @@ describe('useContentHeadline', () => {
     });
 
     const ContentHeadline = defineComponent({
-      template: '<component :is="currentTag" :data-level="level">{{currentTag}}</component>',
+      template: '<component :is="currentTag" :data-level="currentLevel">{{currentTag}}</component>',
       setup() {
-        const { currentTag, level } = useContentHeadline();
-        return { currentTag, level };
+        const { currentTag, currentLevel } = useContentHeadline();
+        return { currentTag, currentLevel };
       }
     });
 
@@ -75,10 +75,10 @@ describe('useContentHeadline (rootTags)', () => {
     });
 
     const ContentHeadline = defineComponent({
-      template: '<component :is="currentTag" :data-level="level">{{ currentTag }}</component>',
+      template: '<component :is="currentTag" :data-level="currentLevel">{{ currentTag }}</component>',
       setup() {
-        const { currentTag, level } = useContentHeadline();
-        return { currentTag, level };
+        const { currentTag, currentLevel } = useContentHeadline();
+        return { currentTag, currentLevel };
       }
     });
 
@@ -140,10 +140,10 @@ describe('useContentHeadline (contentTags)', () => {
     });
 
     const ContentHeadline = defineComponent({
-      template: '<component :is="currentTag" :data-level="level">{{currentTag}}</component>',
+      template: '<component :is="currentTag" :data-level="currentLevel">{{currentTag}}</component>',
       setup() {
-        const { currentTag, level } = useContentHeadline();
-        return { currentTag, level };
+        const { currentTag, currentLevel } = useContentHeadline();
+        return { currentTag, currentLevel };
       }
     });