--- description: Auto-generate listings of child pages. title: Directory listing image: https://developers.cloudflare.com/style-guide/build-the-page/components/directory-listing/og.png?v=c812918ad4accef3 --- [Skip to content](#main-content) > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/style-guide/llms.txt > Use this file to discover all available pages before exploring further. # Directory listing Last updated Aug 20, 2026|Copy as Markdown| [View as Markdown](https://developers.cloudflare.com/style-guide/build-the-page/components/directory-listing/index.md)| [Agent setup](https://developers.cloudflare.com/agent-setup/) The `DirectoryListing` component is used `626` times on `620` pages.

See all examples of pages that use DirectoryListing

Use `` to display the directory of a specific folder, which appears as a list of links. ## Usage ```mdx import { DirectoryListing } from "~/components";

Default

maxDepth

Descriptions

Button

``` ## Props ### `folder` **type:** `string` The folder path to list contents from. If not provided, defaults to the current page's path. ### `button` **type:** `boolean` **default:** `false` When enabled, displays the listing as a 3-column grid of button-style cards (sorted alphabetically) instead of a bullet list. The cards match the style of our [`LinkCard`](https://developers.cloudflare.com/style-guide/build-the-page/components/link-cards/) component. ### `descriptions` **type:** `boolean` **default:** `false` When enabled, shows the [frontmatter `description`](https://developers.cloudflare.com/style-guide/build-the-page/frontmatter/) field for each page in the listing. ### `maxDepth` **type:** `number` **default:** `1` Controls how many levels of nested pages to display. A value of `1` shows only direct children, while higher values will show deeper nesting levels. ### `tag` **type:** `string` Optionally, filter the listing to only pages with a specific tag. ## Associated content types - [Navigation](https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/navigation/) Was this helpful? YesNo ## On this page [![](https://developers.cloudflare.com/_astro/logo.te5VL_aD.svg)Docs](https://developers.cloudflare.com/) ```json {"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/style-guide/build-the-page/components/directory-listing/#page","headline":"Directory listing","description":"Auto-generate listings of child pages.","url":"https://developers.cloudflare.com/style-guide/build-the-page/components/directory-listing/","inLanguage":"en","image":"https://developers.cloudflare.com/style-guide/build-the-page/components/directory-listing/og.png?v=c812918ad4accef3","dateModified":"2026-08-20","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}} ```