> ## Documentation Index
> Fetch the complete documentation index at: https://docs.projectreal.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# openfolderdialog

> Открывает Windows folder picker через Windows file picker с folder selection mode и возвращает выбранную папку как file item.

<div className="real-function-page">
  ```lua theme={null}
  openfolderdialog(options?: DialogOptions): FileSystemItem | nil
  ```

  ## Аргументы

  <ParamField path={"options"} type={"DialogOptions"}>
    Optional table. Для openfolderdialog используются title и defaultPath. defaultPath применяется только если он разрешается в existing directory. extensionFilter принимается shared dialog options parser, но folder selection включается через folder selection mode.
  </ParamField>

  ## Возвраты

  <ResponseField name={"folder"} type={"FileSystemItem | nil"}>
    Selected folder item или nil, если dialog отменен. Dialog failures выбрасывают Failed to open folder dialog.
  </ResponseField>

  ## Типы

  ### DialogOptions

  Настраивает собственный диалог выбора файла или папки.

  | Name               | Type                 | Required | Описание                                                                                 |
  | ------------------ | -------------------- | -------- | ---------------------------------------------------------------------------------------- |
  | `title`            | `string`             | No       | Устанавливает заголовок диалогового окна.                                                |
  | `defaultPath`      | `string`             | No       | Выбирает каталог, отображаемый при открытии диалогового окна.                            |
  | `extensionFilter`  | `&#123;string&#125;` | No       | Ограничивает выбираемые файлы перечисленными расширениями с точкой в начале или без нее. |
  | `suggestedName`    | `string`             | No       | Предоставляет исходное имя файла в диалоговых окнах сохранения.                          |
  | `defaultExtension` | `string`             | No       | Устанавливает расширение, используемое, если введенное имя файла не имеет его.           |

  ## Пример

  Откройте folder picker и обработайте selected folder item или cancellation.

  ```lua theme={null}
  local folder = openfolderdialog({
      title = "Choose a folder",
      defaultPath = ".",
  })

  if folder then
      print(folder:GetName())
      print(folder:IsFolder())
  else
      print("No folder selected")
  end
  ```
</div>