Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes the description about id key in Issue Forms. #9045

Merged
merged 115 commits into from
Aug 24, 2021
Merged
Changes from all commits
Commits
Show all changes
115 commits
Select commit Hold shift + click to select a range
2f0196b
Fixes position of the `id` key in the yaml config.
thispsj Aug 15, 2021
49834a8
Merge branch 'main' into fixforms
thispsj Aug 15, 2021
9cb479b
Merge branch 'main' into fixforms
thispsj Aug 15, 2021
5640100
Merge branch 'main' into fixforms
thispsj Aug 15, 2021
d36b82c
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
495ad94
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
cf31be9
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
b8aa3d6
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
c221347
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
f094f04
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
434689f
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
2048dd8
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
a39e73c
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
cda6661
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
1b54bc1
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
f0a58a9
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
f275b73
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
72ec300
Merge branch 'main' into fixforms
thispsj Aug 16, 2021
a58ba6d
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
037ae7a
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
f85d495
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
27cbf66
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
312e10b
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
4b94229
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
6a4cecf
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
3340e80
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
d94ec0c
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
4e9c27a
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
a89175d
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
c2769c3
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
736b783
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
f726ce6
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
83964aa
Merge branch 'main' into fixforms
thispsj Aug 17, 2021
c027c11
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
62d7fc8
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
2d5cb29
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
1d1a8f7
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
673f042
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
53a0f91
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
9bc1f85
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
f7f08f8
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
b15366b
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
2105abf
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
9a2757d
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
cc061b8
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
9c5f8aa
Merge branch 'main' into fixforms
thispsj Aug 18, 2021
086d350
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
fd9b267
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
50ad0d7
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
678bf9a
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
ec5a27c
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
9349c61
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
4f4906c
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
a0c0f34
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
78b2768
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
a52f856
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
4f8c8fd
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
2bb7f6e
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
edb7b32
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
4e2059b
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
f3d71fe
Merge branch 'main' into fixforms
thispsj Aug 19, 2021
8ec6fb0
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
3e1934b
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
247c3cf
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
030fc45
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
864a96c
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
5337db6
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
cb78f9a
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
961b87f
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
e7ca802
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
00ff0e8
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
82ef372
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
7726a72
Merge branch 'main' into fixforms
thispsj Aug 20, 2021
8c9a5f3
Merge branch 'main' into fixforms
thispsj Aug 21, 2021
5f30572
Merge branch 'main' into fixforms
thispsj Aug 21, 2021
bb68fd2
Merge branch 'main' into fixforms
thispsj Aug 21, 2021
ba26e9c
Merge branch 'main' into fixforms
thispsj Aug 21, 2021
e446bd8
Merge branch 'main' into fixforms
thispsj Aug 21, 2021
49465b0
Merge branch 'main' into fixforms
thispsj Aug 21, 2021
62b4557
Merge branch 'main' into fixforms
thispsj Aug 22, 2021
8886663
Merge branch 'main' into fixforms
thispsj Aug 22, 2021
33910db
Merge branch 'main' into fixforms
thispsj Aug 22, 2021
77eaf90
Merge branch 'main' into fixforms
thispsj Aug 22, 2021
a9917e3
Merge branch 'main' into fixforms
thispsj Aug 22, 2021
31e2523
Merge branch 'main' into fixforms
thispsj Aug 22, 2021
6cc8bc4
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
fa15068
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
a037e4d
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
4aacd8a
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
42d8f92
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
d2af738
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
c435942
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
b40e4c9
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
47068b7
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
09bf7d2
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
da6c09f
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
9d1069a
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
9465c12
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
6ade3f1
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
1a19fab
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
f447a0a
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
7a01b7f
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
443e5d0
Merge branch 'main' into fixforms
thispsj Aug 23, 2021
1b21289
Merge branch 'main' into fixforms
thispsj Aug 24, 2021
22ba4e8
Merge branch 'main' into fixforms
thispsj Aug 24, 2021
68f1cd6
Merge branch 'main' into fixforms
thispsj Aug 24, 2021
14b428b
Merge branch 'main' into fixforms
thispsj Aug 24, 2021
3d03881
Merge branch 'main' into fixforms
thispsj Aug 24, 2021
162cebf
Merge branch 'main' into fixforms
thispsj Aug 24, 2021
8d967cc
Merge branch 'main' into fixforms
thispsj Aug 24, 2021
8530be7
Merge branch 'main' into fixforms
thispsj Aug 24, 2021
1b7d296
Merge branch 'main' into fixforms
thispsj Aug 24, 2021
ece3a8f
Fix Grammar
thispsj Aug 24, 2021
8a3b421
Fix spacing
thispsj Aug 24, 2021
e769a55
Merge branch 'main' into fixforms
thispsj Aug 24, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ For each form element, you can set the following keys.
| Key | Description | Required | Type | Default | Valid values |
| --- | ----------- | -------- | ---- | ------- | ------- |
| `type` | The type of element that you want to define. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | <ul><li>`checkboxes`</li><li>`dropdown`</li><li>`input`</li><li>`markdown`</li><li>`textarea`</li></ul> |
| `id` | The identifier for the element, except when `type` is set to `markdown`. {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `attributes` | A set of key-value pairs that define the properties of the element. | Required | Hash | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `validations` | A set of key-value pairs that set constraints on the element. | Optional | Hash | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |

Expand Down Expand Up @@ -118,7 +119,6 @@ You can use a `textarea` element to add a multi-line text field to your form. Co
| --- | ----------- | -------- | ---- | ------- | ------- |
| `label` | A brief description of the expected user input, which is also displayed in the form. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `description` | A description of the text area to provide context or guidance, which is displayed in the form. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} |
| `id` | The identifier for the text area. {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `placeholder` | A semi-opaque placeholder that renders in the text area when empty. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} |
| `value` | Text that is pre-filled in the text area. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `render` | If a value is provided, submitted text will be formatted into a codeblock. When this key is provided, the text area will not expand for file attachments or Markdown editing. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | Languages known to {% data variables.product.prodname_dotcom %}. For more information, see [the languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). |
Expand Down Expand Up @@ -161,7 +161,6 @@ You can use an `input` element to add a single-line text field to your form.
| Key | Description | Required | Type | Default | Valid values |
| --- | ----------- | -------- | ---- | ------- | ------- |
| `label` | A brief description of the expected user input, which is also displayed in the form. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `id` | The identifier for the input. {% data reusables.form-schema.id-must-be-unique %} If provided, the `id` is the canonical identifier for the field in URL query parameter prefills. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `description` | A description of the field to provide context or guidance, which is displayed in the form. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} |
| `placeholder` | A semi-transparent placeholder that renders in the field when empty. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} |
| `value` | Text that is pre-filled in the field. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
Expand Down Expand Up @@ -199,7 +198,6 @@ You can use a `dropdown` element to add a dropdown menu in your form.
| Key | Description | Required | Type | Default | Valid values |
| --- | ----------- | -------- | ---- | ------- | ------- |
| `label` | A brief description of the expected user input, which is displayed in the form. | Required | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `id` | The identifier for the dropdown. {% data reusables.form-schema.id-must-be-unique %} | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `description` | A description of the dropdown to provide extra context or guidance, which is displayed in the form. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} |
| `multiple` | Determines if the user can select more than one option. | Optional | Boolean | false | {% octicon "dash" aria-label="The dash icon" %} |
| `options` | An array of options the user can choose from. Cannot be empty and all choices must be distinct. | Required | String array | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
Expand Down Expand Up @@ -240,7 +238,6 @@ You can use the `checkboxes` element to add a set of checkboxes to your form.
| Key | Description | Required | Type | Default | Valid values |
| --- | ----------- | -------- | ---- | ------- | ------- |
| `label` | A brief description of the expected user input, which is displayed in the form. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `id` | The identifier for the set of checkboxes. {% data reusables.form-schema.id-must-be-unique %}| Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
| `description` | A description of the set of checkboxes, which is displayed in the form. Supports Markdown formatting. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} |
| `options` | An array of checkboxes that the user can select. For syntax, see below. | Required | Array | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |

Expand Down