Skip to content
Back to search

golemui

The Declarative Form Engine

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/golemui/golemui with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/golemui/golemui'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/golemui--golemui/badge.svg)](/listings/golemui--golemui)

HTML

<a href="/listings/golemui--golemui"><img src="/api/listings/golemui--golemui/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Install the four `@golemui/*` packages for your framework. The versions are published together; use matching versions.

# React
npm i @golemui/core @golemui/react @golemui/gui-react @golemui/gui-shared

# Angular
npm i @golemui/core @golemui/angular @golemui/gui-angular @golemui/gui-shared

# Lit
npm i @golemui/core @golemui/lit @golemui/gui-lit @golemui/gui-shared

# Vue
npm i @golemui/core @golemui/vue @golemui/gui-vue @golemui/gui-shared

# Vanilla JS (web component)
npm i @golemui/core @golemui/lit @golemui/gui-lit @golemui/gui-shared

Import the component styles once, anywhere in your app entry:

@import '@golemui/gui-components/index.css';

Full walkthrough at [golemui.com/getting-started/installation](https://golemui.com/getting-started/installation/).

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 191 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <p align="center">
  2. <a href="https://golemui.com">
  3. <picture>
  4. <source media="(prefers-color-scheme: dark)" srcset=".github/assets/gui-lockup-dark.png">
  5. <img src=".github/assets/gui-lockup-light.png" alt="{gui.} GolemUI" height="64">
  6. </picture>
  7. </a>
  8. </p>
  9. <h3 align="center">The dynamic forms engine.</h3>
  10. <p align="center">Define forms in JSON or JSON Schema. Render them with your favorite framework.</p>
  11. <p align="center">
  12. <a href="https://golemui.com/integration/react/" title="React"><img alt="React" src="https://cdn.simpleicons.org/react/61DAFB" height="44"></a>
  13. &nbsp;&nbsp;&nbsp;&nbsp;
  14. <a href="https://golemui.com/integration/angular/" title="Angular"><img alt="Angular" src="https://cdn.simpleicons.org/angular/DD0031" height="44"></a>
  15. &nbsp;&nbsp;&nbsp;&nbsp;
  16. <a href="https://golemui.com/integration/lit/" title="Lit"><img alt="Lit" src="https://cdn.simpleicons.org/lit/324FFF" height="44"></a>
  17. &nbsp;&nbsp;&nbsp;&nbsp;
  18. <a href="https://golemui.com/integration/vue/" title="Vue"><img alt="Vue" src="https://cdn.simpleicons.org/vuedotjs/4FC08D" height="44"></a>
  19. &nbsp;&nbsp;&nbsp;&nbsp;
  20. <a href="https://golemui.com/integration/overview/" title="Vanilla JS"><img alt="JavaScript" src="https://cdn.simpleicons.org/javascript/F7DF1E" height="44"></a>
  21. </p>
  22. <p align="center">
  23. <a href="https://www.npmjs.com/package/@golemui/gui-shared"><img alt="npm" src="https://img.shields.io/npm/v/@golemui/gui-shared.svg"></a>
  24. <a href="https://github.com/golemui/golemui/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/npm/l/@golemui/gui-shared.svg"></a>
  25. <a href="https://golemui.com"><img alt="docs" src="https://img.shields.io/badge/docs-golemui.com-c15a2c"></a>
  26. </p>
  27. <p align="center">
  28. <a href="https://golemui.com/getting-started/installation/"><strong>Get started</strong></a> ·
  29. <a href="https://golemui.com">Documentation</a> ·
  30. <a href="https://golemui.com/form-definition/how-it-works/">How it works</a> ·
  31. <a href="https://golemui.com/integration/overview/">Integrations</a>
  32. </p>
  33. ---
  34. ## Overview
  35. Define forms with the typed `gui` builder API, or as schema-validated JSON. Both produce the same serializable definition.
  36. - One definition renders in React, Angular, Lit, Vue, or vanilla JS.
  37. - Validation, conditional fields, i18n, and accessibility come from the schema and runtime.
  38. - The output is plain data: store it, transfer it, diff it, generate it.
  39. ## Installation
  40. Install the five `@golemui/*` packages for your framework. The versions are published together; use matching versions.
  41. ```bash
  42. # React
  43. npm i @golemui/core @golemui/react @golemui/gui-react @golemui/gui-components @golemui/gui-shared
  44. # Angular
  45. npm i @golemui/core @golemui/angular @golemui/gui-angular @golemui/gui-components @golemui/gui-shared
  46. # Lit
  47. npm i @golemui/core @golemui/lit @golemui/gui-lit @golemui/gui-components @golemui/gui-shared
  48. # Vue
  49. npm i @golemui/core @golemui/vue @golemui/gui-vue @golemui/gui-components @golemui/gui-shared
  50. # Vanilla JS (web component)
  51. npm i @golemui/core @golemui/lit @golemui/gui-lit @golemui/gui-components @golemui/gui-shared
  52. ```
  53. Import the two stylesheets once, in this order, anywhere in your app entry:
  54. ```scss
  55. @import '@golemui/gui-components/index.css';
  56. @import '@golemui/gui-shared/forms.css';
  57. ```
  58. Full walkthrough at [golemui.com/getting-started/installation](https://golemui.com/getting-started/installation/).
  59. ## Quick start
  60. Define a form as an array of `gui` builders and pass it to the framework component (React shown):
  61. ```tsx
  62. import '@golemui/gui-components/index.css';
  63. import '@golemui/gui-shared/forms.css';
  64. import type { FormSubmitEvent } from '@golemui/core';
  65. import { GuiForm } from '@golemui/gui-react';
  66. import { gui } from '@golemui/gui-shared';
  67. const formDef = [
  68. gui.inputs.textInput('email', {
  69. label: 'Email',
  70. validator: { type: 'string', required: true, format: 'email' },
  71. }),
  72. gui.inputs.password('password', {
  73. label: 'Password',
  74. validator: { type: 'string', required: true, minLength: 8 },
  75. }),
  76. gui.inputs.checkbox('newsletter', {
  77. label: 'Subscribe to the newsletter',
  78. include: { when: '!!$form.email' },
  79. }),
  80. gui.actions.button({
  81. label: 'Sign up',
  82. actionType: 'submit',
  83. disabled: { when: '$formIsInvalid' },
  84. }),
  85. ];
  86. function handleSubmit(event: FormSubmitEvent) {
  87. console.log(event.data);
  88. }
  89. export function App() {
  90. return <GuiForm config={{ formDef }} formSubmit={handleSubmit} />;
  91. }
  92. ```
  93. The submit button stays disabled while the form is invalid (`$formIsInvalid` is a built-in validity flag); on submit, `formSubmit` receives the collected `data`.
  94. The same `formDef` value renders in every supported framework. See [Integrations](https://golemui.com/integration/overview/) for per-framework setup, and the starter templates under [`templates/`](templates/) for runnable examples.
  95. ## Core concepts
  96. **Form definition.** A form is an array of nodes (or a single node). Each node is either a `gui` builder result or a render function. The output is serializable JSON, so a definition can be stored, transferred, and rendered later.
  97. **The `gui` builder.** Exported from `@golemui/gui-shared`, grouped into namespaces:
  98. | Namespace | Purpose | Examples |
  99. | --------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  100. | `gui.inputs` | Field widgets | `textInput`, `numberInput`, `password`, `textarea`, `checkbox`, `dropdown`, `select`, `radiogroup`, `currency`, `tags`, `datePicker`, `timeInput`, `dateTimeInput`, `calendar`, `repeater`, `list`, `custom` |
  101. | `gui.actions` | Buttons and custom actions | `button`, `custom` |
  102. | `gui.displays` | Non-input content | `display`, `alert`, `markdownText`, `custom` |
  103. | `gui.layouts` | Containers | `grid`, `tabs`, `accordion`, `custom` |
  104. | `gui.selectors` | Select and update widgets by type, uid, tag, or state | - |
  105. **Conditional fields.** Widgets accept `include` / `exclude` with a reactive expression over form data:
  106. ```ts
  107. gui.inputs.radiogroup('city', { label: 'City', include: { when: '!!$form.country' } });
  108. gui.actions.button({ label: 'Reset', include: { when: '$form.debug === true' } });
  109. ```
  110. `$form.<path>` reads the current form data; the expression is evaluated at runtime.
  111. **Rendering per framework.** Every adapter takes the definition through a `config` prop and emits a form submit event:
  112. | Framework | Import | Element |
  113. | --------- | ------------------------------------------------------ | ------------------------------------------------------------- |
  114. | React | `import { GuiForm } from '@golemui/gui-react'` | `<GuiForm config={config} formSubmit={handler} />` |
  115. | Vue | `import { GuiForm } from '@golemui/gui-vue'` | `<GuiForm :config="config" @form-submit="handler" />` |
  116. | Angular | `import { FormComponent } from '@golemui/gui-angular'` | `<gui-form [config]="config" (formSubmit)="handler($event)">` |
  117. | Lit | `import '@golemui/gui-lit'` | `<gui-form .config=${config} @formSubmit=${handler}>` |
  118. For vanilla JS, import `@golemui/gui-lit` to register the `<gui-form>` custom element, then set `el.config = config` and listen for the `formSubmit` event (`e.detail` is the `FormSubmitEvent`).
  119. ## Features
  120. - **Validation.** [`@standard-schema/spec`](https://standardschema.dev/) compliant. Built-in `string`, `number`, `boolean`, `array`, and `custom` validators with rules such as `required`, `minLength`, `format`, `minimum`/`maximum`, and `const`. Error messages are localizable, and timing is configurable via `validateOn` (`change`, `blur`, `submit`, `eager`). [Docs](https://golemui.com/features/validators/)
  121. - **Internationalization.** Provide an `I18nTranslator` adapter (i18next, Lingui, or your own) through `localization`. Labels, hints, and validator messages are translatable, with live language switching and automatic RTL. [Docs](https://golemui.com/features/i18n/)
  122. - **Accessibility.** Native form elements with ARIA wiring managed for you: `aria-describedby` for hints, `aria-invalid` and `aria-errormessage` on errors, plus keyboard navigation on interactive widgets.
  123. - **Theming.** Styling is driven by CSS custom properties (design tokens) from a single stylesheet. Override tokens, or supply your own widget components through `customWidgetLoaders`. [Docs](https://golemui.com/styling/theming/)
  124. - **AI assistants (MCP).** `@golemui/gui-mcp` ships a `golemui-mcp` Model Context Protocol server with tools to validate form definitions, generate them from JSON Schema or OpenAPI, and type-check `gui.*` code.
  125. - **AI assistants (skill).** An installable [agent skill](./skills/golemui/SKILL.md) grounds coding agents in the real GolemUI API even without the MCP connected - `npx skills add golemui/golemui` (works with Claude Code, Cursor, and other [skills.sh](https://skills.sh)-compatible agents). Its API reference is generated from the same compile-verified registry the MCP serves, so the two never disagree.
  126. ## Packages
  127. | Package | Description |
  128. | --------------------------------------------------- | ------------------------------------------------------------------------------ |
  129. | `@golemui/gui-react` / `-angular` / `-lit` / `-vue` | Framework form component and bindings |
  130. | `@golemui/gui-shared` | The `gui` builder, form definition types (`GuiFormInitConfig`) and `forms.css` |
  131. | `@golemui/gui-components` | Lit web components, usable with or without forms, and their stylesheets |
  132. | `@golemui/core` | Framework-agnostic form runtime and shared types (`FormEvent`, `ValidateOn`) |
  133. | `@golemui/gui-validators` | Validation schemas (`@standard-schema/spec`) |
  134. | `@golemui/schemas` | The shared core JSON Schema (common defs) and the schema tree generator |
  135. | `@golemui/gui-schemas` | JSON Schemas for gui form definitions, generated from the widget manifest |
  136. | `@golemui/gui-mcp` | MCP server for coding assistants |
  137. Import only from a package's public entry points. The `@golemui/*/internals` paths are internal and unstable.
  138. ## Documentation
  139. [**golemui.com**](https://golemui.com) for full docs, API reference, per-framework guides, examples, and migration paths.
  140. Upgrading from 1.x? See [MIGRATION-v2.md](MIGRATION-v2.md).
  141. ## Contributing
  142. See [CONTRIBUTING.md](CONTRIBUTING.md). The repository is an Nx monorepo; tests run on Vitest, and pull requests follow Conventional Commits.
  143. ## License
  144. [MIT](LICENSE)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.