mi6 / mi6/ic-ui-kit

[*NEW* ic-form]: Form component which takes in JSON and dynamically creates a form

Open
#465 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dx ICDS Core Team spike
Dominant language
TypeScript
Stars
53
Forks
63
Avg merge
2d 4h
Merged PRs (30d)
15

Description

## Summary
This idea is inspired by https://rjsf-team.github.io/react-jsonschema-form/docs/.
We would create a `ic-form` which takes in a JSON schema. The JSON schema would include:
- component to render
- label
- validation
- name
- required and more.

The form created will contain all ICDS components. The following events will be emitted from the component:
- change
- error
- submit

## 💰 User value
This will allow developers to quickly build forms instead of worrying about which component to use, layout and what objects are returned from the form. This will all be handled by the Form component.

## Additional information
- Is this something worth looking into?
- What are the pros and cons of building a form component which takes in JSON?

## 📚 User Stories
TBC

## 📝 Acceptance Criteria
TBC

## ✏ Designs
N/A

## 🧾 Guidance
TBC

## Related stories
https://github.com/mi6/ic-design-system/issues/188
https://github.com/mi6/ic-design-system/issues/189
https://github.com/mi6/ic-design-system/issues/203
https://github.com/mi6/ic-design-system/issues/222
https://github.com/mi6/ic-ui-kit/issues/465

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No implementation files, tests, entry points, user stories, or acceptance criteria are named. First clarify the JSON schema, supported ICDS components, emitted events, and scope; done would be an agreed specification and concrete acceptance criteria for the proposed form component.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.