{"id":13930207,"url":"https://github.com/SolidOS/solid-ui","last_synced_at":"2025-07-19T12:32:01.867Z","repository":{"id":38356676,"uuid":"56784703","full_name":"SolidOS/solid-ui","owner":"SolidOS","description":"User Interface widgets and utilities for Solid","archived":false,"fork":false,"pushed_at":"2024-11-20T14:40:23.000Z","size":138634,"stargazers_count":148,"open_issues_count":153,"forks_count":41,"subscribers_count":30,"default_branch":"main","last_synced_at":"2024-11-20T15:37:46.917Z","etag":null,"topics":["forms","running-code","storybook","typescript"],"latest_commit_sha":null,"homepage":"https://solidos.github.io/solid-ui/dist/solid-ui.js","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SolidOS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-21T15:22:48.000Z","updated_at":"2024-11-20T14:40:32.000Z","dependencies_parsed_at":"2024-02-07T14:59:21.623Z","dependency_job_id":"84a57f3f-6963-45a3-a6cb-00a8bec27855","html_url":"https://github.com/SolidOS/solid-ui","commit_stats":{"total_commits":1433,"total_committers":34,"mean_commits":42.14705882352941,"dds":0.73831123517097,"last_synced_commit":"6a9639ed3ed2cd0a96d3c6cd7446c3147bfd3582"},"previous_names":[],"tags_count":99,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidOS%2Fsolid-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidOS%2Fsolid-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidOS%2Fsolid-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidOS%2Fsolid-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SolidOS","download_url":"https://codeload.github.com/SolidOS/solid-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226607612,"owners_count":17658483,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["forms","running-code","storybook","typescript"],"created_at":"2024-08-07T18:05:13.467Z","updated_at":"2024-11-26T19:30:56.352Z","avatar_url":"https://github.com/SolidOS.png","language":"TypeScript","readme":"# solid-ui\n\n[![NPM Package](https://img.shields.io/npm/v/solid-ui.svg)](https://www.npmjs.com/package/solid-ui)\n\nUser Interface widgets and utilities for Solid (solid-ui)\n\nThese are HTML5 widgets which connect to a solid store. Building blocks for solid-based apps.\nVanilla JS.  Includes large widgets like chat, table, matrix, form fields, and small widgets.\n\nSee [Solid-Ui Storybook](http://solidos.github.io/solid-ui/examples/storybook/) for SolidUI widgets.\nSee [Solid-UI API](https://solidos.github.io/solid-ui/Documentation/api/) for SolidUI functions.\nSee [Forms introduction](./Documentation/FormsReadme.md) for UI vocabulary implementation.\n\nTable of content:\n- Getting started(#getting-started)\n- Further documentation(#further-ocumentation)\n\n\n## Getting started\n\nContributions of bug fixes and new functionality, documentation, and tests are\nalways appreciated.\n\n### In npm-based projects\nWhen including solid-ui in an npm-based project, you can use it with:\n\n```js\n  import { ns, rdf,  acl, aclControl, create, dom, icons, log, matrix, media,\n  messageArea, infiniteMessageArea, pad, preferences, style, table, tabs, utils, widgets, versionInfo\n} from 'solid-ui'\n\n```\n### Directly in a webpage\nClone this repo, and in the repo root run:\n\n* `npm install`\n* `npm run build`\n\nThis will generate a `dist/` folder containing, among other artifacts, `dist/main.js`.\nNow run `npx serve` and go to http://localhost:3000/Documentation/ with your browser to see some examples.\n\nWhile viewing one of those examples, you can open the web console in your browser and for instance\ntry how you can create a button:\n```js\nconst solidLogo = 'https://solidproject.org/assets/img/solid-emblem.svg'\nconst myButton = UI.widgets.button(document, solidLogo, 'test', () =\u003e window.alert('clicked!'))\nUI.widgets.clearElement(document.body)\ndocument.body.appendChild(myButton)\n```\n\nOr a chat widget:\n```js\nconst chatChannel = 'https://example-user.inrupt.net/public/example-chat/index.ttl#this'\nconst chat = UI.infiniteMessageArea(document, store, UI.rdf.namedNode(chatChannel))\ndocument.body.appendChild(chat)\n```\n\n### Development new components\n\nWhen developing a component in solid-ui you can test it in isolation using storybook\n\n```\nnpm run build\nnpm run storybook\n```\n\nIf there is no story for the component yet, add a new one to `./src/stories`.\n\nWhen you want to test the component within a solid-pane, you can use the [development mode of solid-panes](https://github.com/solidos/solid-panes#development).\n\n## Adding Tests\n\nThe following document gives guidance on how to add and perform testing in solid-ui.\n[Testing in solid-ui](https://github.com/SolidOS/solid-ui/blob/18070a02fa8159a2b83d9503ee400f8e046bf1f6/test/unit/README.md)\n\n## Further documentation\n\n- [Some code know-how](https://github.com/SolidOS/solidos/wiki/2.-Solid-UI-know-how)\n","funding_links":[],"categories":["typescript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSolidOS%2Fsolid-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSolidOS%2Fsolid-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSolidOS%2Fsolid-ui/lists"}