Komponensek

Összetettebb előre elkészített komponensek a dokumentáció interaktív és strukturált tartalommal való gazdagításához.

Accordion

Lenyitható tartalmi szekciók létrehozása a jobb információszervezés érdekében. Használd az accordion és accordion-item komponenseket egy Accordion megjelenítéséhez a tartalomban.

Yes! Check out the pricing here: Pricing

::accordion
---
defaultValue:
  - '1'
---

::accordion-item{label="Does Yaplet have a free plan?" icon="i-lucide-circle-help"}
Yes! Yaplet has a free plan with 50 free AI answers per month.
::

::accordion-item{label="Can I upgrade to a paid plan?" icon="i-lucide-circle-help"}
Yes! Check out the pricing here: [Pricing](/pricing)
::

::accordion-item{label="What is the difference between the free and paid plans?" icon="i-lucide-circle-help"}
The free plan has a limit of 50 free AI answers per month. The paid plans have no limits and include additional features.
::

::
PropDefaultType
type'multiple'"multiple" | "single"
ui{ root?: ClassNameValue; trigger?: ClassNameValue; } & { root?: ClassNameValue; item?: ClassNameValue; header?: ClassNameValue; trigger?: ClassNameValue; content?: ClassNameValue; body?: ClassNameValue; leadingIcon?: ClassNameValue; trailingIcon?: ClassNameValue; label?: ClassNameValue; }

Badge

Verziószámok, státuszcímkék és tagek megjelenítése a tartalomban. Használj markdown-t a badge komponens alapértelmezett slotjában egy Badge megjelenítéséhez a tartalomban.

v4.0.0
::badge
**v4.0.0**
::

Callout

Fontos információk kiemelése szemet gyönyörködtető színes dobozokkal és ikonokkal.

Használj markdown-t a callout komponens alapértelmezett slotjában, hogy figyelemfelkeltő kontextust adj a tartalomhoz. Használd az icon és color propokat a testreszabáshoz.

This is a callout with full markdown support.
::callout{icon="i-lucide-square-play" color="neutral" to="/pricing"}
This is a `callout` with full **markdown** support.
::

Gyorsbillentyűk

Here's some additional information.
Here's a helpful suggestion.
Be careful with this action as it might have unexpected results.
This action cannot be undone.
::note
Here's some additional information.
::

::tip
Here's a helpful suggestion.
::

::warning
Be careful with this action as it might have unexpected results.
::

::caution
This action cannot be undone.
::

PropDefaultType
tostring | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric
targetnull | "_blank" | "_parent" | "_self" | "_top" | string & {}
iconany
color'neutral'"error" | "primary" | "secondary" | "success" | "info" | "warning" | "neutral"
ui{ base?: ClassNameValue; icon?: ClassNameValue; externalIcon?: ClassNameValue; }

Card

Kiemelt tartalmi blokkok létrehozása opcionális linkekkel és navigációval. Használj markdown-t a card komponens alapértelmezett slotjában a tartalom kiemeléséhez. Használd a title, icon és color propokat a testreszabáshoz.

Live Chat

Best suited for real-time customer support and instant communication with your visitors.

::card{title="Live Chat" icon="i-lucide-message-circle" color="primary" to="/live-chat"}
Best suited for real-time customer support and instant communication with your visitors.
::
PropDefaultType
asany
variant"solid" | "outline" | "soft" | "subtle" | undefined
titlestring | undefined
iconany
color'primary'"error" | "primary" | "secondary" | "success" | "info" | "warning" | "neutral"
tostring | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric
targetnull | "_blank" | "_parent" | "_self" | "_top" | string & {}
ui{ root?: ClassNameValue; header?: ClassNameValue; body?: ClassNameValue; footer?: ClassNameValue; }

CardGroup

Több kártya rendezése reszponzív rácselrendezésben a jobb tartalom-megjelenítés érdekében. Csomagold a card komponenseidet a card-group komponenssel, hogy rácselrendezésben jelenjenek meg.

Live Chat

Real-time customer support and instant communication.

AI Chatbot

Automated responses powered by AI to handle common questions.

Knowledge Base

Self-service documentation and help articles for your customers.

Automation

Workflow automation and marketing campaigns.

::card-group
::card{icon="i-lucide-message-circle" title="Live Chat" to="/live-chat" target="_blank"}
Real-time customer support and instant communication.
::

::card{icon="i-lucide-bot" title="AI Chatbot" to="/custom-bots" target="_blank"}
Automated responses powered by AI to handle common questions.
::

::card{icon="i-lucide-book-open" title="Knowledge Base" to="/knowledge-base" target="_blank"}
Self-service documentation and help articles for your customers.
::

::card{icon="i-lucide-zap" title="Automation" to="/automated-marketing" target="_blank"}
Workflow automation and marketing campaigns.
::
::

CodeCollapse

Hosszú kódblokkok összecsukhatóvá tétele a helytakarékosság és a jobb olvashatóság érdekében. Csomagold a kódblokkod a code-collapse komponenssel egy összecsukható kódblokk megjelenítéséhez.

main.css
@import "tailwindcss";

@theme static {
  --font-sans: 'Public Sans', sans-serif;

  --breakpoint-3xl: 1920px;

  --color-green-50: #EFFDF5;
  --color-green-100: #D9FBE8;
  --color-green-200: #B3F5D1;
  --color-green-300: #75EDAE;
  --color-green-400: #00DC82;
  --color-green-500: #00C16A;
  --color-green-600: #00A155;
  --color-green-700: #007F45;
  --color-green-800: #016538;
  --color-green-900: #0A5331;
  --color-green-950: #052E16;
}
::code-collapse

```css [main.css]
@import "tailwindcss";

@theme static {
  --font-sans: 'Public Sans', sans-serif;

  --breakpoint-3xl: 1920px;

  --color-green-50: #EFFDF5;
  --color-green-100: #D9FBE8;
  --color-green-200: #B3F5D1;
  --color-green-300: #75EDAE;
  --color-green-400: #00DC82;
  --color-green-500: #00C16A;
  --color-green-600: #00A155;
  --color-green-700: #007F45;
  --color-green-800: #016538;
  --color-green-900: #0A5331;
  --color-green-950: #052E16;
}
```

::
PropDefaultType
iconany {lang="ts-type"}
namestring | undefined
openTextstring | undefined
closeTextstring | undefined
openfalseboolean | undefined
ui{ root?: ClassNameValue; footer?: ClassNameValue; trigger?: ClassNameValue; triggerIcon?: ClassNameValue; }

CodeGroup

Több kódpélda csoportosítása füles felületen az egyszerű összehasonlításhoz. Csomagold a kódblokkjaidat a code-group komponenssel, hogy füleken jelenjenek meg.

pnpm add @yaplet/sdk
::code-group

```bash [pnpm]
pnpm add @yaplet/sdk
```

```bash [yarn]
yarn add @yaplet/sdk
```

```bash [npm]
npm install @yaplet/sdk
```

::
PropDefaultType
defaultValue"0"string | undefined
syncstring | undefined
modelValuestring | undefined
ui{ root?: ClassNameValue; list?: ClassNameValue; indicator?: ClassNameValue; trigger?: ClassNameValue; triggerIcon?: ClassNameValue; triggerLabel?: ClassNameValue; }

CodePreview

Kódpéldák megjelenítése előnézettel és forráskóddal a tisztább dokumentáció érdekében. Csomagolj bármilyen tartalmat a code-preview komponenssel, hogy élő előnézetet jeleníts meg a forráskód mellett a code slot használatával.

inline code

`inline code`
::code-preview
`inline code`

#code
```mdc
`inline code`
```
::
PropDefaultType
ui{ root?: ClassNameValue; preview?: ClassNameValue; code?: ClassNameValue; }

CodeTree

Fájl- és mappastruktúrák vizualizálása szintaxiskiemeléssel. Csomagold a kódblokkjaidat a code-tree komponenssel tetszőleges sorrendben a fájlok fanézetben való megjelenítéséhez.

app/app.config.ts
export default defineAppConfig({
  ui: {
    colors: {
      primary: 'green'
    }
  }
})
::code-tree{defaultValue="app/app.config.ts"}
```ts [nuxt.config.ts]
export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  css: ['~/assets/css/main.css']
})
```

```css [app/assets/css/main.css]
@import "tailwindcss";
@import "@nuxt/ui";
```

```ts [app/app.config.ts]
export default defineAppConfig({
  ui: {
    colors: {
      primary: 'green'
    }
  }
})
```

```vue [app/app.vue]
<template>
  <UApp>
    <NuxtPage />
  </UApp>
</template>
```

```json [package.json]
{
  "name": "nuxt-app",
  "private": true,
  "type": "module",
  "scripts": {
    "build": "nuxt build",
    "dev": "nuxt dev",
    "generate": "nuxt generate",
    "preview": "nuxt preview",
    "postinstall": "nuxt prepare",
    "typecheck": "nuxt typecheck"
  },
  "dependencies": {
    "@iconify-json/lucide": "^1.2.18",
    "@nuxt/ui": "^4.0.0",
    "nuxt": "^4.0.0"
  },
  "devDependencies": {
    "typescript": "^5.8.2",
    "vue-tsc": "^2.2.10"
  }
}
```
::
PropDefaultType
defaultValuestring | undefined
expandAllfalseboolean | undefined
ui{ root?: ClassNameValue; list?: ClassNameValue; item?: ClassNameValue; listWithChildren?: ClassNameValue; itemWithChildren?: ClassNameValue; link?: ClassNameValue; linkLeadingIcon?: ClassNameValue; linkLabel?: ClassNameValue; linkTrailing?: ClassNameValue; linkTrailingIcon?: ClassNameValue; content?: ClassNameValue; }

Collapsible

Tartalom láthatóságának váltása sima kinyitás és összecsukás animációkkal. Csomagold a tartalmadat a collapsible komponenssel egy Collapsible megjelenítéséhez a tartalomban.

::collapsible
| Prop    | Default   | Type                     |
|---------|-----------|--------------------------|
| `name`  |           | `string`{lang="ts-type"} |
| `size`  | `md`      | `string`{lang="ts-type"} |
| `color` | `neutral` | `string`{lang="ts-type"} |
::
PropDefaultType
asany
disabledboolean | undefined
defaultOpenboolean | undefined
openboolean | undefined
unmountOnHidetrueboolean | undefined
ui{ root?: ClassNameValue; content?: ClassNameValue; }

Field

API paraméterek, propok és konfigurációs lehetőségek egyértelmű dokumentálása. Egy mező, prop vagy paraméter megjelenítése a tartalomban.

apiKey
string required
The description can be set as prop or in the default slot with full markdown support.
::field{name="apiKey" type="string" required}
The `description` can be set as prop or in the default slot with full **markdown** support.
::
PropDefaultType
asany
namestring | undefined
typestring | undefined
descriptionstring | undefined
requiredboolean | undefined
ui{ root?: ClassNameValue; container?: ClassNameValue; name?: ClassNameValue; wrapper?: ClassNameValue; required?: ClassNameValue; type?: ClassNameValue; description?: ClassNameValue; }

FieldGroup

Kapcsolódó mezők csoportosítása átfogó API dokumentációhoz. Mezők csoportosítása egy listában.

analytics
boolean
Default to false - Enables analytics for your project.
storage
boolean
Default to false - Enables storage to store static assets, such as images, videos and more.
cache
boolean
Default to false - Enables cache storage to cache your server route responses.
database
boolean
Default to false - Enables SQL database to store your application's data.
::field-group
::field{name="analytics" type="boolean"}
Default to `false` - Enables analytics for your project.
::

::field{name="storage" type="boolean"}
Default to `false` - Enables storage to store static assets, such as images, videos and more.
::

::field{name="cache" type="boolean"}
Default to `false` - Enables cache storage to cache your server route responses.
::

::field{name="database" type="boolean"}
Default to `false` - Enables SQL database to store your application's data.
::
::
PropDefaultType
asany
size"md" | "xs" | "sm" | "lg" | "xl" | undefined
orientation"horizontal""horizontal" | "vertical" | undefined
ui{}

Icon

Ikonok megjelenítése népszerű ikonkönyvtárakból a tartalom gazdagításához Iconify. Használd az icon komponenst egy Ikon megjelenítéséhez a tartalomban.

::icon{name="i-lucide-message-circle"}
PropDefaultType
nameany
mode"svg" | "css" | undefined
sizestring | number | undefined
customize((content: string, name?: string | undefined, prefix?: string | undefined, provider?: string | undefined) => string) | undefined

Kbd

Billentyűparancsok és billentyűkombinációk megjelenítése megfelelő stílussal. Használd a kbd komponenst egy Kbd megjelenítéséhez a tartalomban.

K

:kbd{value="meta"} :kbd{value="K"}
PropDefaultType
as"kbd"any
valuestring | undefined
color"error" | "primary" | "secondary" | "success" | "info" | "warning" | "neutral" | undefined
variant"outline" | "soft" | "subtle" | "solid" | undefined
size"sm" | "md" | "lg" | undefined

Steps

Címsorok átalakítása számozott, lépésről lépésre haladó útmutatókká és oktatóanyagokká. Csomagold a címsoraidat a Steps komponenssel a lépések listájának megjelenítéséhez. Használd a level propot annak meghatározásához, hogy melyik címsorszint legyen a lépéseknél.

Add the Nuxt UI module in your nuxt.config.ts

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxt/ui']
})

Import Tailwind CSS in your CSS

assets/css/main.css
@import "tailwindcss";

Start your development server

npm run dev
::steps{level="4"}

#### Add the Nuxt UI module in your `nuxt.config.ts`

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  modules: ['@nuxt/ui']
})
```

#### Import Tailwind CSS in your CSS

```css [assets/css/main.css]
@import "tailwindcss";
```

#### Start your development server

```bash
npm run dev
```

::
PropDefaultType
level"3" | "2" | "4" | undefined

Tabs

Kapcsolódó tartalmak rendezése interaktív füles felületen. Használd a tabs és tabs-item komponenseket Tabok megjelenítéséhez a tartalomban.

::callout
This is a callout with full markdown support.
::
::tabs
:::tabs-item{label="Code" icon="i-lucide-code"}
```mdc
::callout
This is a callout with full markdown support.
::
```
:::

:::tabs-item{label="Preview" icon="i-lucide-eye"}
::callout
This is a callout with full markdown support.
::
:::
::
PropDefaultType
asany
itemsTabsItem[] | undefined
color"primary" | "secondary" | "success" | "info" | "warning" | "error" | "neutral" | undefined
variant"pill" | "link" | undefined
size"sm" | "xs" | "md" | "lg" | "xl" | undefined
orientation"horizontal"DataOrientation | undefined
contenttrueboolean | undefined
labelKey"label"GetItemKeys<TabsItem> | undefined
defaultValue"0"string | number | undefined
modelValuestring | number | undefined
activationMode"automatic" | "manual" | undefined
unmountOnHidetrueboolean | undefined
ui{ root?: ClassNameValue; list?: ClassNameValue; indicator?: ClassNameValue; trigger?: ClassNameValue; leadingIcon?: ClassNameValue; leadingAvatar?: ClassNameValue; leadingAvatarSize?: ClassNameValue; label?: ClassNameValue; trailingBadge?: ClassNameValue; trailingBadgeSize?: ClassNameValue; content?: ClassNameValue; }