UNPKG

@ztl-uwu/nuxt-content

Version:

Write your content inside your Nuxt app

572 lines 16.3 kB
{ "framework": "vue", "name": "@ztl-uwu/nuxt-content", "version": "2.13.8", "contributions": { "html": { "description-markup": "markdown", "types-syntax": "typescript", "tags": [ { "name": "ContentDoc", "description": "", "attributes": [ { "name": "tag", "required": false, "description": "The tag to use for the renderer element if it is used.", "value": { "kind": "expression", "type": "string" }, "default": "'div'" }, { "name": "excerpt", "description": "Whether or not to render the excerpt.", "value": { "kind": "expression", "type": "boolean" }, "default": "false" }, { "name": "path", "required": false, "description": "The path of the content to load from content source.", "value": { "kind": "expression", "type": "string" }, "default": "undefined" }, { "name": "query", "required": false, "description": "A query builder params object to be passed to <ContentQuery /> component.", "value": { "kind": "expression", "type": "QueryBuilderParams" }, "default": "undefined" }, { "name": "head", "required": false, "description": "Whether or not to map the document data to the `head` property.", "value": { "kind": "expression", "type": "boolean" }, "default": "undefined" } ], "slots": [ { "name": "not-found", "description": "Document not found fallback" }, { "name": "empty", "description": "Document empty fallback" } ], "source": { "module": "./src/runtime/components/ContentDoc.vue", "symbol": "default" } }, { "name": "ContentList", "description": "", "attributes": [ { "name": "path", "required": false, "description": "The path of the content to load from content source.", "value": { "kind": "expression", "type": "string" }, "default": "undefined" }, { "name": "query", "required": false, "description": "A query builder params object to be passed to <ContentQuery /> component.", "value": { "kind": "expression", "type": "QueryBuilderParams" }, "default": "undefined" } ], "slots": [ { "name": "not-found", "description": "Content not found fallback" }, { "name": "empty", "description": "Content empty fallback" } ], "source": { "module": "./src/runtime/components/ContentList.vue", "symbol": "default" } }, { "name": "ContentNavigation", "description": "", "attributes": [ { "name": "query", "required": false, "description": "A query to be passed to `fetchContentNavigation()`.", "value": { "kind": "expression", "type": "QueryBuilderParams | QueryBuilder" }, "default": "undefined" } ], "slots": [ { "name": "empty", "description": "Navigation empty fallback" } ], "source": { "module": "./src/runtime/components/ContentNavigation.vue", "symbol": "default" } }, { "name": "ContentQuery", "description": "", "attributes": [ { "name": "path", "required": false, "description": "The path of the content to load from content source.", "value": { "kind": "expression", "type": "string" }, "default": "undefined" }, { "name": "only", "required": false, "description": "Select a subset of fields", "value": { "kind": "expression", "type": "Array<string>" }, "default": "undefined" }, { "name": "without", "required": false, "description": "Remove a subset of fields", "value": { "kind": "expression", "type": "Array<string>" }, "default": "undefined" }, { "name": "where", "required": false, "description": "Filter results", "value": { "kind": "expression", "type": "{ [key: string]: any }" }, "default": "undefined" }, { "name": "sort", "required": false, "description": "Sort results", "value": { "kind": "expression", "type": "SortParams" }, "default": "undefined" }, { "name": "limit", "required": false, "description": "Limit number of results", "value": { "kind": "expression", "type": "number" }, "default": "undefined" }, { "name": "skip", "required": false, "description": "Skip number of results", "value": { "kind": "expression", "type": "number" }, "default": "undefined" }, { "name": "locale", "required": false, "description": "Filter contents based on locale", "value": { "kind": "expression", "type": "string" }, "default": "undefined" }, { "name": "find", "required": false, "description": "A type of query to be made.", "value": { "kind": "expression", "type": "string" }, "default": "undefined" } ], "slots": [ { "name": "not-found", "description": "Content not found fallback" } ], "source": { "module": "./src/runtime/components/ContentQuery.vue", "symbol": "default" } }, { "name": "ContentRenderer", "description": "", "attributes": [ { "name": "value", "required": false, "description": "The document to render.", "value": { "kind": "expression", "type": "object" }, "default": "{}" }, { "name": "excerpt", "description": "Whether or not to render the excerpt.", "value": { "kind": "expression", "type": "boolean" }, "default": "false" }, { "name": "tag", "description": "The tag to use for the renderer element if it is used.", "value": { "kind": "expression", "type": "string" }, "default": "'div'" } ], "slots": [ { "name": "empty", "description": "Content empty fallback" } ], "source": { "module": "./src/runtime/components/ContentRenderer.vue", "symbol": "default" } }, { "name": "ContentRendererMarkdown", "description": "", "attributes": [ { "name": "value", "required": true, "description": "Content to render", "value": { "kind": "expression", "type": "object" } }, { "name": "excerpt", "description": "Render only the excerpt", "value": { "kind": "expression", "type": "boolean" }, "default": "false" }, { "name": "tag", "description": "Root tag to use for rendering", "value": { "kind": "expression", "type": "string" }, "default": "'div'" }, { "name": "components", "description": "The map of custom components to use for rendering.", "value": { "kind": "expression", "type": "object" }, "default": "{}" }, { "name": "data", "value": { "kind": "expression", "type": "object" }, "default": "{}" } ], "source": { "module": "./src/runtime/components/ContentRendererMarkdown.vue", "symbol": "default" } }, { "name": "ContentSlot", "description": "", "attributes": [ { "name": "use", "description": "A slot name or function", "value": { "kind": "expression", "type": "func" }, "default": "undefined" }, { "name": "unwrap", "description": "Tags to unwrap separated by spaces\nExample: 'ul li'", "value": { "kind": "expression", "type": "boolean|string" }, "default": "false" } ], "source": { "module": "./src/runtime/components/ContentSlot.vue", "symbol": "default" } }, { "name": "DocumentDrivenEmpty", "description": "Used in `src/runtime/pages/document-driven.vue`", "attributes": [ { "name": "value", "required": true, "value": { "kind": "expression", "type": "ParsedContent" } } ], "source": { "module": "./src/runtime/components/DocumentDrivenEmpty.vue", "symbol": "default" } }, { "name": "DocumentDrivenNotFound", "description": "Used in `src/runtime/pages/document-driven.vue`", "source": { "module": "./src/runtime/components/DocumentDrivenNotFound.vue", "symbol": "default" } }, { "name": "Markdown", "description": "Markdown component", "attributes": [ { "name": "use", "description": "A slot name or function", "value": { "kind": "expression", "type": "func" }, "default": "undefined" }, { "name": "unwrap", "description": "Tags to unwrap separated by spaces\nExample: 'ul li'", "value": { "kind": "expression", "type": "boolean|string" }, "default": "false" } ], "source": { "module": "./src/runtime/components/Markdown.vue", "symbol": "default" } }, { "name": "ProseCode", "description": "", "attributes": [ { "name": "code", "value": { "kind": "expression", "type": "string" }, "default": "''" }, { "name": "language", "value": { "kind": "expression", "type": "string" }, "default": "null" }, { "name": "filename", "value": { "kind": "expression", "type": "string" }, "default": "null" }, { "name": "highlights", "value": { "kind": "expression", "type": "Array as () => number[]" }, "default": "() => []" }, { "name": "meta", "value": { "kind": "expression", "type": "string" }, "default": "null" } ], "slots": [ { "name": "default" } ], "source": { "module": "./src/runtime/components/Prose/ProseCode.vue", "symbol": "default" } }, { "name": "ProseCodeInline", "description": "", "slots": [ { "name": "default" } ], "source": { "module": "./src/runtime/components/Prose/ProseCodeInline.vue" } }, { "name": "ProsePre", "description": "", "attributes": [ { "name": "code", "value": { "kind": "expression", "type": "string" }, "default": "''" }, { "name": "language", "value": { "kind": "expression", "type": "string" }, "default": "null" }, { "name": "filename", "value": { "kind": "expression", "type": "string" }, "default": "null" }, { "name": "highlights", "value": { "kind": "expression", "type": "Array as () => number[]" }, "default": "() => []" }, { "name": "meta", "value": { "kind": "expression", "type": "string" }, "default": "null" }, { "name": "class", "value": { "kind": "expression", "type": "string" }, "default": "null" }, { "name": "style", "value": { "kind": "expression", "type": "string|object" }, "default": "null" } ], "slots": [ { "name": "default" } ], "source": { "module": "./src/runtime/components/Prose/ProsePre.vue", "symbol": "default" } } ] } } }