From ddaeea810c0758831a80cf0b6cc331a5a684f8bf Mon Sep 17 00:00:00 2001
From: Maksim Sukharev <antreesy.web@gmail.com>
Date: Mon, 19 Aug 2024 17:33:27 +0200
Subject: [PATCH] chore(docs): add documentation section for composables

Signed-off-by: Maksim Sukharev <antreesy.web@gmail.com>
---
 docs/composables.md  | 27 +++++++++++++++++++++++++++
 styleguide.config.js |  7 +++++++
 2 files changed, 34 insertions(+)
 create mode 100644 docs/composables.md

diff --git a/docs/composables.md b/docs/composables.md
new file mode 100644
index 0000000000..07980cfcdc
--- /dev/null
+++ b/docs/composables.md
@@ -0,0 +1,27 @@
+<!--
+ - SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ - SPDX-License-Identifier: AGPL-3.0-or-later
+-->
+
+### Registration
+
+To use any composable, import and use it according to documentation or Vue guidelines, for example:
+
+```js static
+import { useIsMobile } from '@nextcloud/vue/dist/composables/useIsMobile.js'
+
+export default {
+	setup() {
+		return {
+			isMobile: useIsMobile(),
+		}
+	},
+}
+```
+or in `<script setup>`:
+
+```js static
+import { useIsMobile } from '@nextcloud/vue/dist/composables/useIsMobile.js'
+
+const isMobile = useIsMobile()
+```
diff --git a/styleguide.config.js b/styleguide.config.js
index 728cc409cd..90fe5c015a 100644
--- a/styleguide.config.js
+++ b/styleguide.config.js
@@ -139,6 +139,13 @@ module.exports = async () => {
 					},
 				],
 			},
+			{
+				name: 'Composables',
+				content: 'docs/composables.md',
+				sectionDepth: 1,
+				sections: [
+				],
+			},
 			{
 				name: 'Components',
 				content: 'docs/components.md',