diff --git a/docs/dialogs/directory-picker.mdx b/docs/dialogs/directory-picker.mdx index 8bf73ebd..f42c3326 100644 --- a/docs/dialogs/directory-picker.mdx +++ b/docs/dialogs/directory-picker.mdx @@ -6,6 +6,7 @@ description: 'Let users pick a folder with the native directory dialog' import { Platforms } from '/snippets/platforms.jsx' import DialogResult from '/snippets/dialog-result.mdx' +import { FileKitDemo } from '/snippets/demo-embed.jsx' @@ -35,6 +36,12 @@ val directory: PlatformFile? = FileKit.openDirectoryPicker() +## Try it + +This is the FileKit sample running in your browser. Pick a folder to browse its contents as a tree, then open a file to inspect its metadata. + + + ## Options In Compose, pass these options to `rememberDirectoryPickerLauncher`. `launch()` takes no arguments. diff --git a/docs/dialogs/gallery-picker.mdx b/docs/dialogs/gallery-picker.mdx index b8fbb8ef..0cc20f7b 100644 --- a/docs/dialogs/gallery-picker.mdx +++ b/docs/dialogs/gallery-picker.mdx @@ -6,6 +6,7 @@ description: 'Let users pick photos and videos with the native gallery on Androi import { Platforms } from '/snippets/platforms.jsx' import DialogResult from '/snippets/dialog-result.mdx' +import { FileKitDemo } from '/snippets/demo-embed.jsx' @@ -38,6 +39,12 @@ val image: PlatformFile? = FileKit.openFilePicker(type = FileKitType.Image) Every [file picker option](/dialogs/file-picker#options) applies, including the state-tracking modes. +## Try it + +This is the FileKit sample running in your browser. Choose images, videos, or both, switch the selection mode, then open a file to inspect its metadata. In a browser the picker is a file input filtered to media files. + + + ## What users see | Platform | Dialog | diff --git a/docs/docs.json b/docs/docs.json index 3aff7554..01e26370 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -7,11 +7,11 @@ "name": "FileKit", "description": "FileKit is a Kotlin Multiplatform library to pick, save, read, and write files on Android, iOS, macOS, JVM desktop, Linux, and Windows with native dialogs, plus browser file pickers and downloads on JS and Wasm.", "colors": { - "primary": "#0D9373", - "light": "#07C983", - "dark": "#0D9373" + "primary": "#1A7F4B", + "light": "#E3C266", + "dark": "#1A7F4B" }, - "favicon": "/favicon.svg", + "favicon": "/brand/favicon.svg", "navigation": { "groups": [ { @@ -80,8 +80,18 @@ ] }, "logo": { - "light": "/logo/light-0.10.2.svg", - "dark": "/logo/dark-0.10.2.svg" + "light": "/brand/logo-light.svg", + "dark": "/brand/logo-dark.svg" + }, + "seo": { + "metatags": { + "og:image": "https://filekit.mintlify.app/brand/og.jpg", + "og:image:width": "1200", + "og:image:height": "630", + "og:image:alt": "FileKit: file operations, pickers, and dialogs for Kotlin and Compose Multiplatform", + "twitter:card": "summary_large_image", + "twitter:image": "https://filekit.mintlify.app/brand/og.jpg" + } }, "navbar": { "primary": { diff --git a/docs/favicon.svg b/docs/favicon.svg deleted file mode 100644 index 6a323326..00000000 --- a/docs/favicon.svg +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/images/hero-10.png b/docs/images/hero-10.png deleted file mode 100644 index 3f35ac8a..00000000 Binary files a/docs/images/hero-10.png and /dev/null differ diff --git a/docs/images/hero-13.png b/docs/images/hero-13.png deleted file mode 100644 index 4f85203a..00000000 Binary files a/docs/images/hero-13.png and /dev/null differ diff --git a/docs/images/hero-dark.svg b/docs/images/hero-dark.svg deleted file mode 100644 index c6a30e88..00000000 --- a/docs/images/hero-dark.svg +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/images/hero-light.svg b/docs/images/hero-light.svg deleted file mode 100644 index 297d68fb..00000000 --- a/docs/images/hero-light.svg +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/introduction.mdx b/docs/introduction.mdx index d8ad0e6d..68a7b8b8 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -5,12 +5,14 @@ description: Pick, save, read, and write files with one Kotlin Multiplatform API og:title: FileKit --- - - FileKit logo: file picker and utilities for Kotlin Multiplatform KMP, Compose Multiplatform CMP - +FileKit: file operations, pickers, and dialogs for Kotlin and Compose Multiplatform **FileKit is the file layer for Kotlin Multiplatform.** Open native file, photo, directory, and camera pickers, save and share files, and read or write them through a single `PlatformFile` type. The same code runs on Android, iOS, macOS, desktop JVM (Windows, macOS, Linux), Linux and Windows native, JS, and Wasm, and FileKit Core also runs on watchOS. diff --git a/docs/logo/dark-0.10.2.svg b/docs/logo/dark-0.10.2.svg deleted file mode 100644 index a26c7e54..00000000 --- a/docs/logo/dark-0.10.2.svg +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/logo/dark.svg b/docs/logo/dark.svg deleted file mode 100644 index a6283786..00000000 --- a/docs/logo/dark.svg +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/logo/light-0.10.2.svg b/docs/logo/light-0.10.2.svg deleted file mode 100644 index 75b6f969..00000000 --- a/docs/logo/light-0.10.2.svg +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/logo/light-0.10.svg b/docs/logo/light-0.10.svg deleted file mode 100644 index 4314c2fe..00000000 --- a/docs/logo/light-0.10.svg +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/logo/light.svg b/docs/logo/light.svg deleted file mode 100644 index 582b3b95..00000000 --- a/docs/logo/light.svg +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/style.css b/docs/style.css new file mode 100644 index 00000000..ef39539a --- /dev/null +++ b/docs/style.css @@ -0,0 +1,4 @@ +/* The brand logo is cropped tight to its ink, so the default navbar height (28px) renders it too large */ +img.nav-logo { + height: 1.375rem; +}