@databricks/appkit-ui 0.5.3 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (220) hide show
  1. package/CLAUDE.md +14 -3
  2. package/NOTICE.md +2 -0
  3. package/bin/appkit.js +0 -0
  4. package/dist/cli/commands/plugins-sync.js +369 -0
  5. package/dist/cli/commands/plugins-sync.js.map +1 -0
  6. package/dist/cli/commands/plugins.js +19 -0
  7. package/dist/cli/commands/plugins.js.map +1 -0
  8. package/dist/cli/index.js +2 -0
  9. package/dist/cli/index.js.map +1 -1
  10. package/dist/react/charts/area/index.d.ts +2 -2
  11. package/dist/react/charts/bar/index.d.ts +2 -2
  12. package/dist/react/charts/base.d.ts +2 -2
  13. package/dist/react/charts/base.d.ts.map +1 -1
  14. package/dist/react/charts/create-chart.d.ts +2 -2
  15. package/dist/react/charts/create-chart.d.ts.map +1 -1
  16. package/dist/react/charts/heatmap/index.d.ts +2 -2
  17. package/dist/react/charts/line/index.d.ts +2 -2
  18. package/dist/react/charts/pie/index.d.ts +3 -3
  19. package/dist/react/charts/radar/index.d.ts +2 -2
  20. package/dist/react/charts/scatter/index.d.ts +2 -2
  21. package/dist/react/charts/wrapper.d.ts +2 -2
  22. package/dist/react/charts/wrapper.d.ts.map +1 -1
  23. package/dist/react/table/data-table.d.ts +2 -2
  24. package/dist/react/table/data-table.d.ts.map +1 -1
  25. package/dist/react/ui/accordion.d.ts +5 -5
  26. package/dist/react/ui/accordion.d.ts.map +1 -1
  27. package/dist/react/ui/alert-dialog.d.ts +12 -12
  28. package/dist/react/ui/alert-dialog.d.ts.map +1 -1
  29. package/dist/react/ui/alert.d.ts +6 -6
  30. package/dist/react/ui/alert.d.ts.map +1 -1
  31. package/dist/react/ui/aspect-ratio.d.ts +2 -2
  32. package/dist/react/ui/avatar.d.ts +4 -4
  33. package/dist/react/ui/badge.d.ts +4 -4
  34. package/dist/react/ui/breadcrumb.d.ts +8 -8
  35. package/dist/react/ui/button-group.d.ts +6 -6
  36. package/dist/react/ui/button.d.ts +5 -5
  37. package/dist/react/ui/calendar.d.ts +3 -3
  38. package/dist/react/ui/card.d.ts +8 -8
  39. package/dist/react/ui/carousel.d.ts +6 -6
  40. package/dist/react/ui/chart.d.ts +5 -5
  41. package/dist/react/ui/checkbox.d.ts +2 -2
  42. package/dist/react/ui/collapsible.d.ts +4 -4
  43. package/dist/react/ui/command.d.ts +10 -10
  44. package/dist/react/ui/context-menu.d.ts +16 -16
  45. package/dist/react/ui/dialog.d.ts +11 -11
  46. package/dist/react/ui/dialog.d.ts.map +1 -1
  47. package/dist/react/ui/drawer.d.ts +11 -11
  48. package/dist/react/ui/drawer.d.ts.map +1 -1
  49. package/dist/react/ui/dropdown-menu.d.ts +16 -16
  50. package/dist/react/ui/empty.d.ts +9 -9
  51. package/dist/react/ui/field.d.ts +13 -13
  52. package/dist/react/ui/form.d.ts +7 -7
  53. package/dist/react/ui/hover-card.d.ts +4 -4
  54. package/dist/react/ui/input-group.d.ts +11 -11
  55. package/dist/react/ui/input-group.d.ts.map +1 -1
  56. package/dist/react/ui/input-otp.d.ts +5 -5
  57. package/dist/react/ui/input.d.ts +2 -2
  58. package/dist/react/ui/item.d.ts +11 -11
  59. package/dist/react/ui/kbd.d.ts +3 -3
  60. package/dist/react/ui/label.d.ts +2 -2
  61. package/dist/react/ui/menubar.d.ts +17 -17
  62. package/dist/react/ui/navigation-menu.d.ts +9 -9
  63. package/dist/react/ui/pagination.d.ts +8 -8
  64. package/dist/react/ui/popover.d.ts +5 -5
  65. package/dist/react/ui/progress.d.ts +2 -2
  66. package/dist/react/ui/radio-group.d.ts +3 -3
  67. package/dist/react/ui/resizable.d.ts +4 -4
  68. package/dist/react/ui/scroll-area.d.ts +3 -3
  69. package/dist/react/ui/select.d.ts +11 -11
  70. package/dist/react/ui/separator.d.ts +2 -2
  71. package/dist/react/ui/sheet.d.ts +9 -9
  72. package/dist/react/ui/sidebar.d.ts +24 -24
  73. package/dist/react/ui/skeleton.d.ts +2 -2
  74. package/dist/react/ui/slider.d.ts +2 -2
  75. package/dist/react/ui/sonner.d.ts +2 -2
  76. package/dist/react/ui/spinner.d.ts +2 -2
  77. package/dist/react/ui/switch.d.ts +2 -2
  78. package/dist/react/ui/table.d.ts +9 -9
  79. package/dist/react/ui/tabs.d.ts +5 -5
  80. package/dist/react/ui/textarea.d.ts +2 -2
  81. package/dist/react/ui/toggle-group.d.ts +3 -3
  82. package/dist/react/ui/toggle.d.ts +2 -2
  83. package/dist/react/ui/tooltip.d.ts +5 -5
  84. package/dist/react/ui/tooltip.d.ts.map +1 -1
  85. package/docs/docs/api/appkit/Class.AppKitError/index.html +5 -5
  86. package/docs/docs/api/appkit/Class.AuthenticationError/index.html +4 -4
  87. package/docs/docs/api/appkit/Class.ConfigurationError/index.html +4 -4
  88. package/docs/docs/api/appkit/Class.ConnectionError/index.html +4 -4
  89. package/docs/docs/api/appkit/Class.ExecutionError/index.html +4 -4
  90. package/docs/docs/api/appkit/Class.InitializationError/index.html +4 -4
  91. package/docs/docs/api/appkit/Class.Plugin/index.html +28 -16
  92. package/docs/docs/api/appkit/Class.Plugin.md +90 -30
  93. package/docs/docs/api/appkit/Class.ResourceRegistry/index.html +150 -0
  94. package/docs/docs/api/appkit/Class.ResourceRegistry.md +301 -0
  95. package/docs/docs/api/appkit/Class.ServerError/index.html +5 -5
  96. package/docs/docs/api/appkit/Class.TunnelError/index.html +4 -4
  97. package/docs/docs/api/appkit/Class.ValidationError/index.html +4 -4
  98. package/docs/docs/api/appkit/Enumeration.ResourceType/index.html +66 -0
  99. package/docs/docs/api/appkit/Enumeration.ResourceType.md +135 -0
  100. package/docs/docs/api/appkit/Function.appKitTypesPlugin/index.html +4 -4
  101. package/docs/docs/api/appkit/Function.createApp/index.html +4 -4
  102. package/docs/docs/api/appkit/Function.getExecutionContext/index.html +5 -5
  103. package/docs/docs/api/appkit/Function.getPluginManifest/index.html +26 -0
  104. package/docs/docs/api/appkit/Function.getPluginManifest.md +24 -0
  105. package/docs/docs/api/appkit/Function.getResourceRequirements/index.html +28 -0
  106. package/docs/docs/api/appkit/Function.getResourceRequirements.md +42 -0
  107. package/docs/docs/api/appkit/Function.isSQLTypeMarker/index.html +5 -5
  108. package/docs/docs/api/appkit/Interface.BasePluginConfig/index.html +4 -4
  109. package/docs/docs/api/appkit/Interface.CacheConfig/index.html +4 -4
  110. package/docs/docs/api/appkit/Interface.ITelemetry/index.html +5 -5
  111. package/docs/docs/api/appkit/Interface.PluginManifest/index.html +63 -0
  112. package/docs/docs/api/appkit/Interface.PluginManifest.md +135 -0
  113. package/docs/docs/api/appkit/Interface.ResourceEntry/index.html +83 -0
  114. package/docs/docs/api/appkit/Interface.ResourceEntry.md +156 -0
  115. package/docs/docs/api/appkit/Interface.ResourceFieldEntry/index.html +26 -0
  116. package/docs/docs/api/appkit/Interface.ResourceFieldEntry.md +25 -0
  117. package/docs/docs/api/appkit/Interface.ResourceRequirement/index.html +51 -0
  118. package/docs/docs/api/appkit/Interface.ResourceRequirement.md +84 -0
  119. package/docs/docs/api/appkit/Interface.StreamExecutionSettings/index.html +5 -5
  120. package/docs/docs/api/appkit/Interface.TelemetryConfig/index.html +5 -5
  121. package/docs/docs/api/appkit/Interface.ValidationResult/index.html +29 -0
  122. package/docs/docs/api/appkit/Interface.ValidationResult.md +36 -0
  123. package/docs/docs/api/appkit/TypeAlias.ConfigSchema/index.html +21 -0
  124. package/docs/docs/api/appkit/TypeAlias.ConfigSchema.md +12 -0
  125. package/docs/docs/api/appkit/TypeAlias.IAppRouter/index.html +5 -5
  126. package/docs/docs/api/appkit/TypeAlias.ResourcePermission/index.html +18 -0
  127. package/docs/docs/api/appkit/TypeAlias.ResourcePermission.md +20 -0
  128. package/docs/docs/api/appkit/Variable.sql/index.html +5 -5
  129. package/docs/docs/api/appkit/index.html +10 -8
  130. package/docs/docs/api/appkit-ui/data/AreaChart/index.html +3 -3
  131. package/docs/docs/api/appkit-ui/data/BarChart/index.html +3 -3
  132. package/docs/docs/api/appkit-ui/data/DataTable/index.html +3 -3
  133. package/docs/docs/api/appkit-ui/data/DonutChart/index.html +3 -3
  134. package/docs/docs/api/appkit-ui/data/HeatmapChart/index.html +3 -3
  135. package/docs/docs/api/appkit-ui/data/LineChart/index.html +3 -3
  136. package/docs/docs/api/appkit-ui/data/PieChart/index.html +3 -3
  137. package/docs/docs/api/appkit-ui/data/RadarChart/index.html +3 -3
  138. package/docs/docs/api/appkit-ui/data/ScatterChart/index.html +3 -3
  139. package/docs/docs/api/appkit-ui/index.html +3 -3
  140. package/docs/docs/api/appkit-ui/styling/index.html +3 -3
  141. package/docs/docs/api/appkit-ui/ui/Accordion/index.html +3 -3
  142. package/docs/docs/api/appkit-ui/ui/Alert/index.html +3 -3
  143. package/docs/docs/api/appkit-ui/ui/AlertDialog/index.html +3 -3
  144. package/docs/docs/api/appkit-ui/ui/AspectRatio/index.html +3 -3
  145. package/docs/docs/api/appkit-ui/ui/Avatar/index.html +3 -3
  146. package/docs/docs/api/appkit-ui/ui/Badge/index.html +3 -3
  147. package/docs/docs/api/appkit-ui/ui/Breadcrumb/index.html +3 -3
  148. package/docs/docs/api/appkit-ui/ui/Button/index.html +3 -3
  149. package/docs/docs/api/appkit-ui/ui/ButtonGroup/index.html +3 -3
  150. package/docs/docs/api/appkit-ui/ui/Calendar/index.html +3 -3
  151. package/docs/docs/api/appkit-ui/ui/Card/index.html +3 -3
  152. package/docs/docs/api/appkit-ui/ui/Carousel/index.html +3 -3
  153. package/docs/docs/api/appkit-ui/ui/ChartContainer/index.html +3 -3
  154. package/docs/docs/api/appkit-ui/ui/Checkbox/index.html +3 -3
  155. package/docs/docs/api/appkit-ui/ui/Collapsible/index.html +3 -3
  156. package/docs/docs/api/appkit-ui/ui/Command/index.html +3 -3
  157. package/docs/docs/api/appkit-ui/ui/ContextMenu/index.html +3 -3
  158. package/docs/docs/api/appkit-ui/ui/Dialog/index.html +3 -3
  159. package/docs/docs/api/appkit-ui/ui/Drawer/index.html +3 -3
  160. package/docs/docs/api/appkit-ui/ui/DropdownMenu/index.html +3 -3
  161. package/docs/docs/api/appkit-ui/ui/Empty/index.html +3 -3
  162. package/docs/docs/api/appkit-ui/ui/Field/index.html +3 -3
  163. package/docs/docs/api/appkit-ui/ui/FormControl/index.html +3 -3
  164. package/docs/docs/api/appkit-ui/ui/HoverCard/index.html +3 -3
  165. package/docs/docs/api/appkit-ui/ui/Input/index.html +3 -3
  166. package/docs/docs/api/appkit-ui/ui/InputGroup/index.html +3 -3
  167. package/docs/docs/api/appkit-ui/ui/InputOTP/index.html +3 -3
  168. package/docs/docs/api/appkit-ui/ui/Item/index.html +3 -3
  169. package/docs/docs/api/appkit-ui/ui/Kbd/index.html +3 -3
  170. package/docs/docs/api/appkit-ui/ui/Label/index.html +3 -3
  171. package/docs/docs/api/appkit-ui/ui/Menubar/index.html +3 -3
  172. package/docs/docs/api/appkit-ui/ui/NavigationMenu/index.html +3 -3
  173. package/docs/docs/api/appkit-ui/ui/Pagination/index.html +3 -3
  174. package/docs/docs/api/appkit-ui/ui/Popover/index.html +3 -3
  175. package/docs/docs/api/appkit-ui/ui/Progress/index.html +3 -3
  176. package/docs/docs/api/appkit-ui/ui/RadioGroup/index.html +3 -3
  177. package/docs/docs/api/appkit-ui/ui/ResizableHandle/index.html +3 -3
  178. package/docs/docs/api/appkit-ui/ui/ScrollArea/index.html +3 -3
  179. package/docs/docs/api/appkit-ui/ui/Select/index.html +3 -3
  180. package/docs/docs/api/appkit-ui/ui/Separator/index.html +3 -3
  181. package/docs/docs/api/appkit-ui/ui/Sheet/index.html +3 -3
  182. package/docs/docs/api/appkit-ui/ui/Sidebar/index.html +3 -3
  183. package/docs/docs/api/appkit-ui/ui/Skeleton/index.html +3 -3
  184. package/docs/docs/api/appkit-ui/ui/Slider/index.html +3 -3
  185. package/docs/docs/api/appkit-ui/ui/Spinner/index.html +3 -3
  186. package/docs/docs/api/appkit-ui/ui/Switch/index.html +3 -3
  187. package/docs/docs/api/appkit-ui/ui/Table/index.html +3 -3
  188. package/docs/docs/api/appkit-ui/ui/Tabs/index.html +3 -3
  189. package/docs/docs/api/appkit-ui/ui/Textarea/index.html +3 -3
  190. package/docs/docs/api/appkit-ui/ui/Toaster/index.html +3 -3
  191. package/docs/docs/api/appkit-ui/ui/Toggle/index.html +3 -3
  192. package/docs/docs/api/appkit-ui/ui/ToggleGroup/index.html +3 -3
  193. package/docs/docs/api/appkit-ui/ui/Tooltip/index.html +3 -3
  194. package/docs/docs/api/appkit.md +44 -28
  195. package/docs/docs/api/index.html +3 -3
  196. package/docs/docs/app-management/index.html +4 -4
  197. package/docs/docs/app-management.md +1 -1
  198. package/docs/docs/architecture/index.html +4 -4
  199. package/docs/docs/architecture.md +1 -1
  200. package/docs/docs/category/development/index.html +4 -4
  201. package/docs/docs/category/development.md +1 -1
  202. package/docs/docs/configuration/index.html +3 -3
  203. package/docs/docs/core-principles/index.html +3 -3
  204. package/docs/docs/development/ai-assisted-development/index.html +7 -35
  205. package/docs/docs/development/ai-assisted-development.md +3 -52
  206. package/docs/docs/development/index.html +5 -5
  207. package/docs/docs/development/llm-guide/index.html +3 -3
  208. package/docs/docs/development/local-development/index.html +5 -5
  209. package/docs/docs/development/local-development.md +2 -2
  210. package/docs/docs/development/project-setup/index.html +3 -3
  211. package/docs/docs/development/remote-bridge/index.html +4 -4
  212. package/docs/docs/development/remote-bridge.md +1 -1
  213. package/docs/docs/development/type-generation/index.html +3 -3
  214. package/docs/docs/development.md +2 -2
  215. package/docs/docs/index.html +5 -20
  216. package/docs/docs/plugins/index.html +18 -8
  217. package/docs/docs/plugins.md +82 -4
  218. package/docs/docs.md +1 -32
  219. package/llms.txt +14 -3
  220. package/package.json +3 -1
package/docs/docs/api/appkit-ui/ui/Toaster/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">Toaster | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toaster"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Toaster | AppKit"><meta data-rh="true" name="description" content="Toast notification system for displaying temporary messages"><meta data-rh="true" property="og:description" content="Toast notification system for displaying temporary messages"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toaster"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toaster" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toaster" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"API reference","item":"https://databricks.github.io/appkit/docs/api/"},{"@type":"ListItem","position":2,"name":"@databricks/appkit-ui","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/"},{"@type":"ListItem","position":3,"name":"Toaster","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toaster"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">Toaster | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toaster"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Toaster | AppKit"><meta data-rh="true" name="description" content="Toast notification system for displaying temporary messages"><meta data-rh="true" property="og:description" content="Toast notification system for displaying temporary messages"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toaster"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toaster" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toaster" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"API reference","item":"https://databricks.github.io/appkit/docs/api/"},{"@type":"ListItem","position":2,"name":"@databricks/appkit-ui","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/"},{"@type":"ListItem","position":3,"name":"Toaster","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toaster"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/api/appkit-ui/ui/Toggle/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">Toggle | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toggle"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Toggle | AppKit"><meta data-rh="true" name="description" content="Button that toggles between pressed and unpressed states"><meta data-rh="true" property="og:description" content="Button that toggles between pressed and unpressed states"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toggle"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toggle" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toggle" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"API reference","item":"https://databricks.github.io/appkit/docs/api/"},{"@type":"ListItem","position":2,"name":"@databricks/appkit-ui","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/"},{"@type":"ListItem","position":3,"name":"Toggle","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toggle"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">Toggle | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toggle"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Toggle | AppKit"><meta data-rh="true" name="description" content="Button that toggles between pressed and unpressed states"><meta data-rh="true" property="og:description" content="Button that toggles between pressed and unpressed states"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toggle"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toggle" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toggle" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"API reference","item":"https://databricks.github.io/appkit/docs/api/"},{"@type":"ListItem","position":2,"name":"@databricks/appkit-ui","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/"},{"@type":"ListItem","position":3,"name":"Toggle","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Toggle"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/api/appkit-ui/ui/ToggleGroup/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">ToggleGroup | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/ToggleGroup"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="ToggleGroup | AppKit"><meta data-rh="true" name="description" content="Group of toggle buttons for selecting one or more options"><meta data-rh="true" property="og:description" content="Group of toggle buttons for selecting one or more options"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/ToggleGroup"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/ToggleGroup" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/ToggleGroup" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"API reference","item":"https://databricks.github.io/appkit/docs/api/"},{"@type":"ListItem","position":2,"name":"@databricks/appkit-ui","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/"},{"@type":"ListItem","position":3,"name":"ToggleGroup","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/ui/ToggleGroup"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">ToggleGroup | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/ToggleGroup"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="ToggleGroup | AppKit"><meta data-rh="true" name="description" content="Group of toggle buttons for selecting one or more options"><meta data-rh="true" property="og:description" content="Group of toggle buttons for selecting one or more options"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/ToggleGroup"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/ToggleGroup" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/ToggleGroup" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"API reference","item":"https://databricks.github.io/appkit/docs/api/"},{"@type":"ListItem","position":2,"name":"@databricks/appkit-ui","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/"},{"@type":"ListItem","position":3,"name":"ToggleGroup","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/ui/ToggleGroup"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/api/appkit-ui/ui/Tooltip/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">Tooltip | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Tooltip"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Tooltip | AppKit"><meta data-rh="true" name="description" content="Brief informational message that appears on hover"><meta data-rh="true" property="og:description" content="Brief informational message that appears on hover"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Tooltip"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Tooltip" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Tooltip" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"API reference","item":"https://databricks.github.io/appkit/docs/api/"},{"@type":"ListItem","position":2,"name":"@databricks/appkit-ui","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/"},{"@type":"ListItem","position":3,"name":"Tooltip","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Tooltip"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">Tooltip | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Tooltip"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Tooltip | AppKit"><meta data-rh="true" name="description" content="Brief informational message that appears on hover"><meta data-rh="true" property="og:description" content="Brief informational message that appears on hover"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Tooltip"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Tooltip" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Tooltip" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"API reference","item":"https://databricks.github.io/appkit/docs/api/"},{"@type":"ListItem","position":2,"name":"@databricks/appkit-ui","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/"},{"@type":"ListItem","position":3,"name":"Tooltip","item":"https://databricks.github.io/appkit/docs/api/appkit-ui/ui/Tooltip"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/api/appkit.md CHANGED
@@ -2,36 +2,50 @@
2
2
 
3
3
  Core library for building Databricks applications with type-safe SQL queries, plugin architecture, and React integration.
4
4
 
5
+ ## Enumerations[​](#enumerations "Direct link to Enumerations")
6
+
7
+ | Enumeration | Description |
8
+ | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
9
+ | [ResourceType](/appkit/docs/api/appkit/Enumeration.ResourceType.md) | Supported resource types that plugins can depend on. Each type has its own set of valid permissions. |
10
+
5
11
  ## Classes[​](#classes "Direct link to Classes")
6
12
 
7
- | Class | Description |
8
- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
9
- | [AppKitError](/appkit/docs/api/appkit/Class.AppKitError.md) | Base error class for all AppKit errors. Provides a consistent structure for error handling across the framework. |
10
- | [AuthenticationError](/appkit/docs/api/appkit/Class.AuthenticationError.md) | Error thrown when authentication fails. Use for missing tokens, invalid credentials, or authorization failures. |
11
- | [ConfigurationError](/appkit/docs/api/appkit/Class.ConfigurationError.md) | Error thrown when configuration is missing or invalid. Use for missing environment variables, invalid settings, or setup issues. |
12
- | [ConnectionError](/appkit/docs/api/appkit/Class.ConnectionError.md) | Error thrown when a connection or network operation fails. Use for database pool errors, API failures, timeouts, etc. |
13
- | [ExecutionError](/appkit/docs/api/appkit/Class.ExecutionError.md) | Error thrown when an operation execution fails. Use for statement failures, canceled operations, or unexpected states. |
14
- | [InitializationError](/appkit/docs/api/appkit/Class.InitializationError.md) | Error thrown when a service or component is not properly initialized. Use when accessing services before they are ready. |
15
- | [Plugin](/appkit/docs/api/appkit/Class.Plugin.md) | Base abstract class for creating AppKit plugins |
16
- | [ServerError](/appkit/docs/api/appkit/Class.ServerError.md) | Error thrown when server lifecycle operations fail. Use for server start/stop issues, configuration conflicts, etc. |
17
- | [TunnelError](/appkit/docs/api/appkit/Class.TunnelError.md) | Error thrown when remote tunnel operations fail. Use for tunnel connection issues, message parsing failures, etc. |
18
- | [ValidationError](/appkit/docs/api/appkit/Class.ValidationError.md) | Error thrown when input validation fails. Use for invalid parameters, missing required fields, or type mismatches. |
13
+ | Class | Description |
14
+ | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | [AppKitError](/appkit/docs/api/appkit/Class.AppKitError.md) | Base error class for all AppKit errors. Provides a consistent structure for error handling across the framework. |
16
+ | [AuthenticationError](/appkit/docs/api/appkit/Class.AuthenticationError.md) | Error thrown when authentication fails. Use for missing tokens, invalid credentials, or authorization failures. |
17
+ | [ConfigurationError](/appkit/docs/api/appkit/Class.ConfigurationError.md) | Error thrown when configuration is missing or invalid. Use for missing environment variables, invalid settings, or setup issues. |
18
+ | [ConnectionError](/appkit/docs/api/appkit/Class.ConnectionError.md) | Error thrown when a connection or network operation fails. Use for database pool errors, API failures, timeouts, etc. |
19
+ | [ExecutionError](/appkit/docs/api/appkit/Class.ExecutionError.md) | Error thrown when an operation execution fails. Use for statement failures, canceled operations, or unexpected states. |
20
+ | [InitializationError](/appkit/docs/api/appkit/Class.InitializationError.md) | Error thrown when a service or component is not properly initialized. Use when accessing services before they are ready. |
21
+ | [Plugin](/appkit/docs/api/appkit/Class.Plugin.md) | Base abstract class for creating AppKit plugins. |
22
+ | [ResourceRegistry](/appkit/docs/api/appkit/Class.ResourceRegistry.md) | Central registry for tracking plugin resource requirements. Deduplication uses type + resourceKey (machine-stable); alias is for display only. |
23
+ | [ServerError](/appkit/docs/api/appkit/Class.ServerError.md) | Error thrown when server lifecycle operations fail. Use for server start/stop issues, configuration conflicts, etc. |
24
+ | [TunnelError](/appkit/docs/api/appkit/Class.TunnelError.md) | Error thrown when remote tunnel operations fail. Use for tunnel connection issues, message parsing failures, etc. |
25
+ | [ValidationError](/appkit/docs/api/appkit/Class.ValidationError.md) | Error thrown when input validation fails. Use for invalid parameters, missing required fields, or type mismatches. |
19
26
 
20
27
  ## Interfaces[​](#interfaces "Direct link to Interfaces")
21
28
 
22
- | Interface | Description |
23
- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
24
- | [BasePluginConfig](/appkit/docs/api/appkit/Interface.BasePluginConfig.md) | Base configuration interface for AppKit plugins |
25
- | [CacheConfig](/appkit/docs/api/appkit/Interface.CacheConfig.md) | Configuration for caching |
26
- | [ITelemetry](/appkit/docs/api/appkit/Interface.ITelemetry.md) | Plugin-facing interface for OpenTelemetry instrumentation. Provides a thin abstraction over OpenTelemetry APIs for plugins. |
27
- | [StreamExecutionSettings](/appkit/docs/api/appkit/Interface.StreamExecutionSettings.md) | Configuration for streaming execution with default and user-scoped settings |
28
- | [TelemetryConfig](/appkit/docs/api/appkit/Interface.TelemetryConfig.md) | OpenTelemetry configuration for AppKit applications |
29
+ | Interface | Description |
30
+ | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
31
+ | [BasePluginConfig](/appkit/docs/api/appkit/Interface.BasePluginConfig.md) | Base configuration interface for AppKit plugins |
32
+ | [CacheConfig](/appkit/docs/api/appkit/Interface.CacheConfig.md) | Configuration for caching |
33
+ | [ITelemetry](/appkit/docs/api/appkit/Interface.ITelemetry.md) | Plugin-facing interface for OpenTelemetry instrumentation. Provides a thin abstraction over OpenTelemetry APIs for plugins. |
34
+ | [PluginManifest](/appkit/docs/api/appkit/Interface.PluginManifest.md) | Plugin manifest that declares metadata and resource requirements. Attached to plugin classes as a static property. |
35
+ | [ResourceEntry](/appkit/docs/api/appkit/Interface.ResourceEntry.md) | Internal representation of a resource in the registry. Extends ResourceRequirement with resolution state and plugin ownership. |
36
+ | [ResourceFieldEntry](/appkit/docs/api/appkit/Interface.ResourceFieldEntry.md) | Defines a single field for a resource. Each field has its own environment variable and optional description. Single-value types use one key (e.g. id); multi-value types (database, secret) use multiple (e.g. instance\_name, database\_name or scope, key). |
37
+ | [ResourceRequirement](/appkit/docs/api/appkit/Interface.ResourceRequirement.md) | Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements(). |
38
+ | [StreamExecutionSettings](/appkit/docs/api/appkit/Interface.StreamExecutionSettings.md) | Configuration for streaming execution with default and user-scoped settings |
39
+ | [TelemetryConfig](/appkit/docs/api/appkit/Interface.TelemetryConfig.md) | OpenTelemetry configuration for AppKit applications |
40
+ | [ValidationResult](/appkit/docs/api/appkit/Interface.ValidationResult.md) | Result of validating all registered resources against the environment. |
29
41
 
30
42
  ## Type Aliases[​](#type-aliases "Direct link to Type Aliases")
31
43
 
32
- | Type Alias | Description |
33
- | ------------------------------------------------------------- | ------------------------------------------------- |
34
- | [IAppRouter](/appkit/docs/api/appkit/TypeAlias.IAppRouter.md) | Express router type for plugin route registration |
44
+ | Type Alias | Description |
45
+ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
46
+ | [ConfigSchema](/appkit/docs/api/appkit/TypeAlias.ConfigSchema.md) | Configuration schema definition for plugin config. Re-exported from the standard JSON Schema Draft 7 types. |
47
+ | [IAppRouter](/appkit/docs/api/appkit/TypeAlias.IAppRouter.md) | Express router type for plugin route registration |
48
+ | [ResourcePermission](/appkit/docs/api/appkit/TypeAlias.ResourcePermission.md) | Union of all possible permission levels across all resource types. |
35
49
 
36
50
  ## Variables[​](#variables "Direct link to Variables")
37
51
 
@@ -41,9 +55,11 @@ Core library for building Databricks applications with type-safe SQL queries, pl
41
55
 
42
56
  ## Functions[​](#functions "Direct link to Functions")
43
57
 
44
- | Function | Description |
45
- | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- |
46
- | [appKitTypesPlugin](/appkit/docs/api/appkit/Function.appKitTypesPlugin.md) | Vite plugin to generate types for AppKit queries. Calls generateFromEntryPoint under the hood. |
47
- | [createApp](/appkit/docs/api/appkit/Function.createApp.md) | Bootstraps AppKit with the provided configuration. |
48
- | [getExecutionContext](/appkit/docs/api/appkit/Function.getExecutionContext.md) | Get the current execution context. |
49
- | [isSQLTypeMarker](/appkit/docs/api/appkit/Function.isSQLTypeMarker.md) | Type guard to check if a value is a SQL type marker |
58
+ | Function | Description |
59
+ | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
60
+ | [appKitTypesPlugin](/appkit/docs/api/appkit/Function.appKitTypesPlugin.md) | Vite plugin to generate types for AppKit queries. Calls generateFromEntryPoint under the hood. |
61
+ | [createApp](/appkit/docs/api/appkit/Function.createApp.md) | Bootstraps AppKit with the provided configuration. |
62
+ | [getExecutionContext](/appkit/docs/api/appkit/Function.getExecutionContext.md) | Get the current execution context. |
63
+ | [getPluginManifest](/appkit/docs/api/appkit/Function.getPluginManifest.md) | Loads and validates the manifest from a plugin constructor. Normalizes string type/permission to strict ResourceType/ResourcePermission. |
64
+ | [getResourceRequirements](/appkit/docs/api/appkit/Function.getResourceRequirements.md) | Gets the resource requirements from a plugin's manifest. |
65
+ | [isSQLTypeMarker](/appkit/docs/api/appkit/Function.isSQLTypeMarker.md) | Type guard to check if a value is a SQL type marker |
package/docs/docs/api/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">API reference | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/api/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="API reference | AppKit"><meta data-rh="true" name="description" content="This section contains the API reference for the AppKit packages."><meta data-rh="true" property="og:description" content="This section contains the API reference for the AppKit packages."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/api/"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"API reference","item":"https://databricks.github.io/appkit/docs/api/"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">API reference | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/api/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="API reference | AppKit"><meta data-rh="true" name="description" content="This section contains the API reference for the AppKit packages."><meta data-rh="true" property="og:description" content="This section contains the API reference for the AppKit packages."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/api/"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/api/" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"API reference","item":"https://databricks.github.io/appkit/docs/api/"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/app-management/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">App management | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/app-management"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="App management | AppKit"><meta data-rh="true" name="description" content="Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps."><meta data-rh="true" property="og:description" content="Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/app-management"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/app-management" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/app-management" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App management","item":"https://databricks.github.io/appkit/docs/app-management"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">App management | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/app-management"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="App management | AppKit"><meta data-rh="true" name="description" content="Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps."><meta data-rh="true" property="og:description" content="Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/app-management"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/app-management" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/app-management" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App management","item":"https://databricks.github.io/appkit/docs/app-management"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
@@ -19,7 +19,7 @@
19
19
  <li class="">Databricks CLI (v0.287.0 or higher): install and configure it according to the <a href="https://docs.databricks.com/aws/en/dev-tools/cli/tutorial" target="_blank" rel="noopener noreferrer" class="">official tutorial</a>.</li>
20
20
  </ul>
21
21
  <h2 class="anchor anchorTargetStickyNavbar_scV4" id="create-app">Create app<a href="#create-app" class="hash-link" aria-label="Direct link to Create app" title="Direct link to Create app" translate="no">​</a></h2>
22
- <p>See the <a class="" href="/appkit/docs/#quick-start-options">Quick start</a> section to create a new Databricks app with AppKit installed.</p>
22
+ <p>See the <a class="" href="/appkit/docs/#quick-start">Quick start</a> section to create a new Databricks app with AppKit installed.</p>
23
23
  <h2 class="anchor anchorTargetStickyNavbar_scV4" id="configuration">Configuration<a href="#configuration" class="hash-link" aria-label="Direct link to Configuration" title="Direct link to Configuration" translate="no">​</a></h2>
24
24
  <p>Before deploying your app, you need to configure it. See the <a class="" href="/appkit/docs/configuration">Configuration guide</a> for details on:</p>
25
25
  <ul>
package/docs/docs/app-management.md CHANGED
@@ -9,7 +9,7 @@ Manage your AppKit application throughout its lifecycle using the Databricks CLI
9
9
 
10
10
  ## Create app[​](#create-app "Direct link to Create app")
11
11
 
12
- See the [Quick start](/appkit/docs.md#quick-start-options) section to create a new Databricks app with AppKit installed.
12
+ See the [Quick start](/appkit/docs.md#quick-start) section to create a new Databricks app with AppKit installed.
13
13
 
14
14
  ## Configuration[​](#configuration "Direct link to Configuration")
15
15
 
package/docs/docs/architecture/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">Architecture | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/architecture"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Architecture | AppKit"><meta data-rh="true" name="description" content="AppKit follows a plugin-based architecture designed for building production-ready Databricks applications. This document provides a high-level overview of the system components and their interactions."><meta data-rh="true" property="og:description" content="AppKit follows a plugin-based architecture designed for building production-ready Databricks applications. This document provides a high-level overview of the system components and their interactions."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/architecture"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/architecture" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/architecture" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Architecture","item":"https://databricks.github.io/appkit/docs/architecture"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">Architecture | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/architecture"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Architecture | AppKit"><meta data-rh="true" name="description" content="AppKit follows a plugin-based architecture designed for building production-ready Databricks applications. This document provides a high-level overview of the system components and their interactions."><meta data-rh="true" property="og:description" content="AppKit follows a plugin-based architecture designed for building production-ready Databricks applications. This document provides a high-level overview of the system components and their interactions."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/architecture"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/architecture" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/architecture" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Architecture","item":"https://databricks.github.io/appkit/docs/architecture"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
@@ -58,7 +58,7 @@
58
58
  <p>Integration with Databricks services:</p>
59
59
  <ul>
60
60
  <li class=""><strong>SQL Warehouses</strong>: Execute analytical queries with Arrow or JSON format</li>
61
- <li class=""><strong>Lakebase</strong>: Access data from Lakebase</li>
61
+ <li class=""><strong>Lakebase V1 (Provisioned)</strong>: Access data from Lakebase Provisioned. Support for Lakebase Autoscaling coming soon.</li>
62
62
  </ul>
63
63
  <h2 class="anchor anchorTargetStickyNavbar_scV4" id="see-also">See also<a href="#see-also" class="hash-link" aria-label="Direct link to See also" title="Direct link to See also" translate="no">​</a></h2>
64
64
  <ul>
package/docs/docs/architecture.md CHANGED
@@ -59,7 +59,7 @@ The Node.js backend layer built with `@databricks/appkit`:
59
59
  Integration with Databricks services:
60
60
 
61
61
  * **SQL Warehouses**: Execute analytical queries with Arrow or JSON format
62
- * **Lakebase**: Access data from Lakebase
62
+ * **Lakebase V1 (Provisioned)**: Access data from Lakebase Provisioned. Support for Lakebase Autoscaling coming soon.
63
63
 
64
64
  ## See also[​](#see-also "Direct link to See also")
65
65
 
package/docs/docs/category/development/index.html CHANGED
@@ -3,14 +3,14 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">Development | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/category/development"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Development | AppKit"><meta data-rh="true" name="description" content="Guides for developing AppKit applications"><meta data-rh="true" property="og:description" content="Guides for developing AppKit applications"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/category/development"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/category/development" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/category/development" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">Development | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/category/development"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Development | AppKit"><meta data-rh="true" name="description" content="Guides for developing AppKit applications"><meta data-rh="true" property="og:description" content="Guides for developing AppKit applications"><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/category/development"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/category/development" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/category/development" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Development","item":"https://databricks.github.io/appkit/docs/category/development"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
12
12
  <symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
13
13
  </defs></svg>
14
- <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus"><link rel="preload" as="image" href="/appkit/img/logo.png"><div role="region" aria-label="Skip to main content"><a class="skipToContent_R3I2" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="theme-announcement-bar announcementBar_Upl7" style="background-color:#f0f0f0;color:#000000" role="banner"><div class="announcementBarPlaceholder_Lvio"></div><div class="content_vq0X announcementBarContent_FIMQ">⚠️ AppKit is in an early development phase and is subject to change without notice. <strong>DO NOT</strong> use in production environments.</div><button type="button" aria-label="Close" class="clean-btn close closeButton_J8WU announcementBarClose_jD94"><svg viewBox="0 0 15 15" width="14" height="14"><g stroke="currentColor" stroke-width="3.1"><path d="M.75.75l13.5 13.5M14.25.75L.75 14.25"></path></g></svg></button></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/appkit/"><div class="navbar__logo"><img src="/appkit/img/logo.png" alt="AppKit" class="themedComponent_hkXO themedComponent--light_BgK8"><img src="/appkit/img/logo.png" alt="AppKit" class="themedComponent_hkXO themedComponent--dark_RKPt"></div><b class="navbar__title text--truncate">AppKit</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/appkit/docs/">Documentation</a><a class="navbar__item navbar__link" href="/appkit/contributing">Contributing</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/databricks/appkit" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_eFYw colorModeToggle_EPbi"><button class="clean-btn toggleButton_HRKp toggleButtonDisabled_bICu" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO lightToggleIcon_vxPA"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO darkToggleIcon_PZNO"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO systemToggleIcon_A7x6"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_cVhq"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper__Y_W"><div class="docsWrapper_cIfN"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_xQFv" type="button"></button><div class="docRoot_FHtD"><aside class="theme-doc-sidebar-container docSidebarContainer_dvCd"><div class="sidebarViewport_GeRf"><div class="sidebar_T8N1"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_uyE9 menuWithAnnouncementBar_Bucd"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/"><span title="Getting started" class="linkLabel_hZzm">Getting started</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/app-management"><span title="App management" class="linkLabel_hZzm">App management</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/plugins"><span title="Plugins" class="linkLabel_hZzm">Plugins</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/architecture"><span title="Architecture" class="linkLabel_hZzm">Architecture</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/configuration"><span title="Configuration" class="linkLabel_hZzm">Configuration</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="categoryLink_P6CU menu__link menu__link--sublist menu__link--active" aria-current="page" href="/appkit/docs/category/development"><span title="Development" class="categoryLinkLabel_ShmP">Development</span></a><button aria-label="Collapse sidebar category &#x27;Development&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/local-development"><span title="Local development" class="linkLabel_hZzm">Local development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/ai-assisted-development"><span title="AI-Assisted development" class="linkLabel_hZzm">AI-Assisted development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/"><span title="Development" class="linkLabel_hZzm">Development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/remote-bridge"><span title="Remote Bridge" class="linkLabel_hZzm">Remote Bridge</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/project-setup"><span title="Project setup" class="linkLabel_hZzm">Project setup</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/type-generation"><span title="Type generation" class="linkLabel_hZzm">Type generation</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/llm-guide"><span title="LLM Guide" class="linkLabel_hZzm">LLM Guide</span></a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/core-principles"><span title="Core principles" class="linkLabel_hZzm">Core principles</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_P6CU menu__link menu__link--sublist" href="/appkit/docs/api/"><span title="API reference" class="categoryLinkLabel_ShmP">API reference</span></a><button aria-label="Expand sidebar category &#x27;API reference&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_P5br"><div class="container padding-top--md padding-bottom--lg"><div class="generatedIndexPage_XI0L"><nav class="theme-doc-breadcrumbs breadcrumbsContainer_bEIa" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/appkit/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_sma7"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Development</span></li></ul></nav><header><h1 class="title_JGm5">Development</h1><p>Guides for developing AppKit applications</p></header><article class="margin-top--lg"><section class="row"><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/local-development"><h2 class="text--truncate cardTitle_QwTc" title="Local development">📄️<!-- --> <!-- -->Local development</h2><p class="text--truncate cardDescription_W6_C" title="Once your app is bootstrapped according to the Manual quick start guide, you can start the development server with hot reload for both UI and backend code.">Once your app is bootstrapped according to the Manual quick start guide, you can start the development server with hot reload for both UI and backend code.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/ai-assisted-development"><h2 class="text--truncate cardTitle_QwTc" title="AI-Assisted development">📄️<!-- --> <!-- -->AI-Assisted development</h2><p class="text--truncate cardDescription_W6_C" title="AppKit integrates with AI coding assistants through the Model Context Protocol (MCP).">AppKit integrates with AI coding assistants through the Model Context Protocol (MCP).</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/"><h2 class="text--truncate cardTitle_QwTc" title="Development">📄️<!-- --> <!-- -->Development</h2><p class="text--truncate cardDescription_W6_C" title="AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.">AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/remote-bridge"><h2 class="text--truncate cardTitle_QwTc" title="Remote Bridge">📄️<!-- --> <!-- -->Remote Bridge</h2><p class="text--truncate cardDescription_W6_C" title="Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.">Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/project-setup"><h2 class="text--truncate cardTitle_QwTc" title="Project setup">📄️<!-- --> <!-- -->Project setup</h2><p class="text--truncate cardDescription_W6_C" title="This guide covers the recommended project structure and scaffolding for AppKit applications.">This guide covers the recommended project structure and scaffolding for AppKit applications.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/type-generation"><h2 class="text--truncate cardTitle_QwTc" title="Type generation">📄️<!-- --> <!-- -->Type generation</h2><p class="text--truncate cardDescription_W6_C" title="AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.">AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/llm-guide"><h2 class="text--truncate cardTitle_QwTc" title="LLM Guide">📄️<!-- --> <!-- -->LLM Guide</h2><p class="text--truncate cardDescription_W6_C" title="This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.">This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.</p></a></article></section></article><footer class="margin-top--md"><nav class="pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/appkit/docs/configuration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/appkit/docs/development/local-development"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Local development</div></a></nav></footer></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/">Getting started</a></li><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/api/">API reference</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/databricks/appkit" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://docs.databricks.com/aws/en/dev-tools/databricks-apps/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks Apps docs<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/databricks/cli" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks CLI<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 Databricks, Inc.</div></div></div></footer></div>
14
+ <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus"><link rel="preload" as="image" href="/appkit/img/logo.png"><div role="region" aria-label="Skip to main content"><a class="skipToContent_R3I2" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="theme-announcement-bar announcementBar_Upl7" style="background-color:#f0f0f0;color:#000000" role="banner"><div class="announcementBarPlaceholder_Lvio"></div><div class="content_vq0X announcementBarContent_FIMQ">⚠️ AppKit is in an early development phase and is subject to change without notice. <strong>DO NOT</strong> use in production environments.</div><button type="button" aria-label="Close" class="clean-btn close closeButton_J8WU announcementBarClose_jD94"><svg viewBox="0 0 15 15" width="14" height="14"><g stroke="currentColor" stroke-width="3.1"><path d="M.75.75l13.5 13.5M14.25.75L.75 14.25"></path></g></svg></button></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/appkit/"><div class="navbar__logo"><img src="/appkit/img/logo.png" alt="AppKit" class="themedComponent_hkXO themedComponent--light_BgK8"><img src="/appkit/img/logo.png" alt="AppKit" class="themedComponent_hkXO themedComponent--dark_RKPt"></div><b class="navbar__title text--truncate">AppKit</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/appkit/docs/">Documentation</a><a class="navbar__item navbar__link" href="/appkit/contributing">Contributing</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/databricks/appkit" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_eFYw colorModeToggle_EPbi"><button class="clean-btn toggleButton_HRKp toggleButtonDisabled_bICu" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO lightToggleIcon_vxPA"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO darkToggleIcon_PZNO"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_brDO systemToggleIcon_A7x6"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_cVhq"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper__Y_W"><div class="docsWrapper_cIfN"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_xQFv" type="button"></button><div class="docRoot_FHtD"><aside class="theme-doc-sidebar-container docSidebarContainer_dvCd"><div class="sidebarViewport_GeRf"><div class="sidebar_T8N1"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_uyE9 menuWithAnnouncementBar_Bucd"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/"><span title="Getting started" class="linkLabel_hZzm">Getting started</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/app-management"><span title="App management" class="linkLabel_hZzm">App management</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/plugins"><span title="Plugins" class="linkLabel_hZzm">Plugins</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/architecture"><span title="Architecture" class="linkLabel_hZzm">Architecture</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/configuration"><span title="Configuration" class="linkLabel_hZzm">Configuration</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="categoryLink_P6CU menu__link menu__link--sublist menu__link--active" aria-current="page" href="/appkit/docs/category/development"><span title="Development" class="categoryLinkLabel_ShmP">Development</span></a><button aria-label="Collapse sidebar category &#x27;Development&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/local-development"><span title="Local development" class="linkLabel_hZzm">Local development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/ai-assisted-development"><span title="AI-Assisted development" class="linkLabel_hZzm">AI-Assisted development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/"><span title="Development" class="linkLabel_hZzm">Development</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/remote-bridge"><span title="Remote Bridge" class="linkLabel_hZzm">Remote Bridge</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/project-setup"><span title="Project setup" class="linkLabel_hZzm">Project setup</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/type-generation"><span title="Type generation" class="linkLabel_hZzm">Type generation</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/appkit/docs/development/llm-guide"><span title="LLM Guide" class="linkLabel_hZzm">LLM Guide</span></a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/appkit/docs/core-principles"><span title="Core principles" class="linkLabel_hZzm">Core principles</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_P6CU menu__link menu__link--sublist" href="/appkit/docs/api/"><span title="API reference" class="categoryLinkLabel_ShmP">API reference</span></a><button aria-label="Expand sidebar category &#x27;API reference&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_P5br"><div class="container padding-top--md padding-bottom--lg"><div class="generatedIndexPage_XI0L"><nav class="theme-doc-breadcrumbs breadcrumbsContainer_bEIa" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/appkit/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_sma7"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Development</span></li></ul></nav><header><h1 class="title_JGm5">Development</h1><p>Guides for developing AppKit applications</p></header><article class="margin-top--lg"><section class="row"><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/local-development"><h2 class="text--truncate cardTitle_QwTc" title="Local development">📄️<!-- --> <!-- -->Local development</h2><p class="text--truncate cardDescription_W6_C" title="Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code.">Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/ai-assisted-development"><h2 class="text--truncate cardTitle_QwTc" title="AI-Assisted development">📄️<!-- --> <!-- -->AI-Assisted development</h2><p class="text--truncate cardDescription_W6_C" title="AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available.">AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/"><h2 class="text--truncate cardTitle_QwTc" title="Development">📄️<!-- --> <!-- -->Development</h2><p class="text--truncate cardDescription_W6_C" title="AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.">AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/remote-bridge"><h2 class="text--truncate cardTitle_QwTc" title="Remote Bridge">📄️<!-- --> <!-- -->Remote Bridge</h2><p class="text--truncate cardDescription_W6_C" title="Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.">Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/project-setup"><h2 class="text--truncate cardTitle_QwTc" title="Project setup">📄️<!-- --> <!-- -->Project setup</h2><p class="text--truncate cardDescription_W6_C" title="This guide covers the recommended project structure and scaffolding for AppKit applications.">This guide covers the recommended project structure and scaffolding for AppKit applications.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/type-generation"><h2 class="text--truncate cardTitle_QwTc" title="Type generation">📄️<!-- --> <!-- -->Type generation</h2><p class="text--truncate cardDescription_W6_C" title="AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.">AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.</p></a></article><article class="docCardListItem_I7il col col--6"><a class="card padding--lg cardContainer_haYF" href="/appkit/docs/development/llm-guide"><h2 class="text--truncate cardTitle_QwTc" title="LLM Guide">📄️<!-- --> <!-- -->LLM Guide</h2><p class="text--truncate cardDescription_W6_C" title="This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.">This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.</p></a></article></section></article><footer class="margin-top--md"><nav class="pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/appkit/docs/configuration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/appkit/docs/development/local-development"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Local development</div></a></nav></footer></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/">Getting started</a></li><li class="footer__item"><a class="footer__link-item" href="/appkit/docs/api/">API reference</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/appkit/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/databricks/appkit" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://docs.databricks.com/aws/en/dev-tools/databricks-apps/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks Apps docs<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/databricks/cli" target="_blank" rel="noopener noreferrer" class="footer__link-item">Databricks CLI<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_miaU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 Databricks, Inc.</div></div></div></footer></div>
15
15
  </body>
16
16
  </html>
package/docs/docs/category/development.md CHANGED
@@ -1,3 +1,3 @@
1
1
  ## [📄️<!-- --> <!-- -->Local development](/appkit/docs/development/local-development.md)
2
2
 
3
- [Once your app is bootstrapped according to the Manual quick start guide, you can start the development server with hot reload for both UI and backend code.](/appkit/docs/development/local-development.md)
3
+ [Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code.](/appkit/docs/development/local-development.md)
package/docs/docs/configuration/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">Configuration | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/configuration"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Configuration | AppKit"><meta data-rh="true" name="description" content="This guide covers environment variables and configuration options for AppKit applications."><meta data-rh="true" property="og:description" content="This guide covers environment variables and configuration options for AppKit applications."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/configuration"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/configuration" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Configuration","item":"https://databricks.github.io/appkit/docs/configuration"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">Configuration | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/configuration"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Configuration | AppKit"><meta data-rh="true" name="description" content="This guide covers environment variables and configuration options for AppKit applications."><meta data-rh="true" property="og:description" content="This guide covers environment variables and configuration options for AppKit applications."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/configuration"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/configuration" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Configuration","item":"https://databricks.github.io/appkit/docs/configuration"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>
package/docs/docs/core-principles/index.html CHANGED
@@ -3,9 +3,9 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="generator" content="Docusaurus v3.9.2">
6
- <title data-rh="true">Core principles | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/core-principles"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Core principles | AppKit"><meta data-rh="true" name="description" content="Learn about the fundamental concepts and principles behind AppKit."><meta data-rh="true" property="og:description" content="Learn about the fundamental concepts and principles behind AppKit."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/core-principles"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/core-principles" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/core-principles" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Core principles","item":"https://databricks.github.io/appkit/docs/core-principles"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.80363e45.css">
7
- <script src="/appkit/assets/js/runtime~main.67c7d5ea.js" defer="defer"></script>
8
- <script src="/appkit/assets/js/main.c3423cc2.js" defer="defer"></script>
6
+ <title data-rh="true">Core principles | AppKit</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://databricks.github.io/appkit/docs/core-principles"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Databricks Apps, Node.js, React.js, SDK, TypeScript, SQL, Databricks, AI, full-stack, development"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Core principles | AppKit"><meta data-rh="true" name="description" content="Learn about the fundamental concepts and principles behind AppKit."><meta data-rh="true" property="og:description" content="Learn about the fundamental concepts and principles behind AppKit."><link data-rh="true" rel="icon" href="/appkit/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://databricks.github.io/appkit/docs/core-principles"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/core-principles" hreflang="en"><link data-rh="true" rel="alternate" href="https://databricks.github.io/appkit/docs/core-principles" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Core principles","item":"https://databricks.github.io/appkit/docs/core-principles"}]}</script><link rel="stylesheet" href="/appkit/assets/css/styles.36a38b99.css">
7
+ <script src="/appkit/assets/js/runtime~main.2bcde09d.js" defer="defer"></script>
8
+ <script src="/appkit/assets/js/main.84fbe5b6.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
11
  <svg style="display: none;"><defs>