@ministryofjustice/fb-components-core - npm Package Compare versions

Comparing version 0.0.48-alpha to 0.0.49-alpha

package.json

@@ -9,3 +9,3 @@ {
   },
-  "version": "0.0.48-alpha",
+  "version": "0.0.49-alpha",
   "description": "Form Builder core components",
@@ -12,0 +12,0 @@ "main": "index.js",

specifications/button/button.schema.json

@@ -35,3 +35,4 @@ {
       "description": "Button text",
-      "type": "string"
+      "type": "string",
+      "content": true
     },
@@ -38,0 +39,0 @@ "href": {

specifications/checkboxes/checkboxes.schema.json

@@ -13,3 +13,3 @@ {
       "title": "Options",
-      "description": "Checkboxes options",
+      "description": "Items that users can select",
       "type": "array",
@@ -16,0 +16,0 @@ "items": {

specifications/content/content.schema.json

@@ -5,3 +5,3 @@ {
   "title": "Content",
-  "description": "Display content",
+  "description": "Display ‘flat’ content, such as text",
   "type": "object",
@@ -16,3 +16,6 @@ "category": [
     "html": {
+      "title": "Content",
+      "description": "Content to display - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
       "type": "string",
+      "content": true,
       "multiline": true
@@ -19,0 +22,0 @@ }

specifications/date/date.schema.json

@@ -16,2 +16,3 @@ {
       "title": "Date type",
+      "description": "The format for entering dates",
       "type": "string",
@@ -18,0 +19,0 @@ "enum": [

specifications/definition/components/definition.components.schema.json

@@ -8,2 +8,3 @@ {
       "title": "Components",
+      "description": "The form or content elements used on the page",
       "type": "array",
@@ -10,0 +11,0 @@ "items": {

specifications/definition/control/definition.control.schema.json

@@ -22,3 +22,3 @@ {
       "title": "Disabled",
-      "description": "Whether or not the control should be disabled",
+      "description": "Whether the control should be disabled",
       "oneOf": [
@@ -25,0 +25,0 @@ {

specifications/definition/fieldset/definition.fieldset.schema.json

@@ -13,7 +13,11 @@ {
       "title": "Legend",
-      "type": "string"
+      "description": "Question or instruction to user - appears above the component. If component is repeatable, the legend appears next to the input, with the number added automatically (for example, child 1)",
+      "type": "string",
+      "content": true
     },
     "hint": {
       "title": "Hint text",
-      "type": "string"
+      "description": "Text to help users answer a question - appears in grey under the legend (like this text)",
+      "type": "string",
+      "content": true
     }
@@ -20,0 +24,0 @@ },

specifications/definition/htmlattributes/definition.htmlattributes.schema.json

@@ -9,4 +9,4 @@ {
     "id": {
-      "title": "Id",
-      "description": "Additional HTML Id to apply to instance - NB. not the same as the instance’s _id",
+      "title": "HTML id",
+      "description": "Additional HTML id to apply to instance - only use as a last resort, to target a specific element on the page",
       "type": "string",
@@ -19,3 +19,3 @@ "category": [
       "title": "Classes",
-      "description": "Additional HTML classes to apply to instance",
+      "description": "Additional HTML classes to apply to instance - to add more than one, separate with a space",
       "type": "string",
@@ -28,3 +28,3 @@ "category": [
       "title": "Attributes",
-      "description": "Additional HTML attributes to apply to instance",
+      "description": "Additional HTML attributes to apply to instance - please enter the attributes as JSON",
       "type": "object",
@@ -31,0 +31,0 @@ "category": [

specifications/definition/label/definition.label.schema.json

@@ -9,7 +9,11 @@ {
       "title": "Label",
-      "type": "string"
+      "description": "Question or instruction to user - appears above the component. If component is repeatable, the label appears next to the input, with the number added automatically (for example, child 1)",
+      "type": "string",
+      "content": true
     },
     "hint": {
       "title": "Hint text",
-      "type": "string"
+      "description": "Text to help users answer a question - appears in grey under the label (like this text)",
+      "type": "string",
+      "content": true
     }
@@ -16,0 +20,0 @@ },

specifications/definition/model/definition.model.schema.json

@@ -9,3 +9,3 @@ {
       "title": "Model name",
-      "description": "Key to store user input for the control against",
+      "description": "Namespace under which to store user inputs - combines with input names of child components",
       "type": "string",
@@ -18,3 +18,3 @@ "category": [
       "title": "Model protection",
-      "description": "Whether to prevent the block’s model being overridden or appended ",
+      "description": "Whether to prevent the component’s model being overridden or appended",
       "type": "boolean",
@@ -21,0 +21,0 @@ "default": false,

specifications/definition/nextpage/definition.nextpage.schema.json

@@ -5,3 +5,3 @@ {
   "title": "Next page",
-  "description": "What page (if any), and under what condtions, to go to next. Please use only if what you’re trying to achieve is impossible or extremely difficult to achieve using the page steps flow.",
+  "description": "What page (or pages) to go to next, and under what conditions. Only use if what you’re trying to achieve is impossible or extremely difficult using page steps",
   "type": "object",
@@ -8,0 +8,0 @@ "oneOf": [

specifications/definition/option/definition.option.schema.json

@@ -8,2 +8,3 @@ {
       "title": "Option value",
+      "description": "Value assigned when users select option",
       "type": "string"
@@ -10,0 +11,0 @@ }

specifications/definition/page/definition.page.schema.json

@@ -8,2 +8,3 @@ {
       "title": "URL",
+      "description": "The page’s relative url - uses the page id unless you specify otherwise",
       "type": "string",
@@ -14,3 +15,5 @@ "pattern": "^[\\w-_\/]+$"
       "title": "Heading",
-      "type": "string"
+      "description": "The page’s top-level heading (H1) - appears at the top of the page",
+      "type": "string",
+      "content": true
     },
@@ -20,2 +23,3 @@ "title": {
       "type": "string",
+      "content": true,
       "category": [
@@ -27,4 +31,5 @@ "additional"
       "title": "Lede",
-      "description": "Introductory paragraph that follows the heading",
+      "description": "Comes after the heading (it‘s also known as the ‘lede’) - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
       "type": "string",
+      "content": true,
       "category": [
@@ -36,4 +41,5 @@ "content"
       "title": "Content",
-      "description": "Free-form content after the heading and lede",
+      "description": "Free-form content after the heading and first paragraph - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
       "type": "string",
+      "content": true,
       "multiline": true,
@@ -40,0 +46,0 @@ "category": [

specifications/definition/page/form/definition.page.form.schema.json

@@ -21,2 +21,3 @@ {
       "type": "string",
+      "content": true,
       "category": [
@@ -36,3 +37,3 @@ "content"
       "title": "Steps",
-      "description": "List of pages making up the sub-journey from the current page",
+      "description": "The ‘child’ pages that follow from this ‘parent’ page",
       "type": "array",
@@ -39,0 +40,0 @@ "items": {

specifications/definition/repeatable/definition.repeatable.schema.json

@@ -9,7 +9,8 @@ {
       "title": "Repeatable",
-      "description": "Whether the page/component should be repeatable",
+      "description": "Whether the page or component lets users ‘add another’ answer",
       "type": "boolean"
     },
     "repeatableMinimum": {
-      "title": "Minimum number of times to repeat items",
+      "title": "Minimum number of repeatable items",
+      "description": "For example, if users must give at least 3 answers, set this to 3 - the page will show 3 inputs when it loads",
       "type": "number",
@@ -21,3 +22,4 @@ "minimum": 0,
     "repeatableMaximum": {
-      "title": "Maximum number of times to repeat items",
+      "title": "Maximum number of repeatable items",
+      "description": "For example, if users can give up to 5 answers, set this to 5",
       "type": "number",
@@ -28,4 +30,4 @@ "minimum": 0,
     "repeatableHeading": {
-      "title": "Repeatable heading",
-      "description": "Heading for repeatable items",
+      "title": "Repeatable section heading",
+      "description": "Heading for repeatable items - appears once before the components",
       "type": "string",
@@ -35,4 +37,4 @@ "category": ["repeatable"]
     "repeatableLede": {
-      "title": "Repeatable section lede",
-      "description": "Introductory paragraph that follows the heading for repeatable items",
+      "title": "Repeatable section first paragraph",
+      "description": "Introductory paragraph - follows the heading",
       "type": "string",
@@ -42,4 +44,4 @@ "category": ["repeatable"]
     "repeatableAdd": {
-      "title": "Add string",
-      "description": "Content used to denote add an item - defaults to ‘Add another’",
+      "title": "Text to add another answer",
+      "description": "Specify the link text for users to add another answer - defaults to ‘Add another’",
       "type": "string",
@@ -50,4 +52,4 @@ "default": "Add another",
     "repeatableDelete": {
-      "title": "Remove string",
-      "description": "Content used to denote delete an item - defaults to ‘Remove’",
+      "title": "Text to remove an answer",
+      "description": "Specify the link text for users to delete an answer - defaults to ‘Remove’",
       "type": "string",
@@ -54,0 +56,0 @@ "default": "Remove",

specifications/definition/widthclass/input/definition.widthclass.input.schema.json

@@ -8,3 +8,3 @@ {
       "title": "Input width",
-      "description": "Determines govuk width class to apply to input",
+      "description": "The govuk width class to apply to input",
       "type": "string",
@@ -11,0 +11,0 @@ "enumMap": "widthClassMap",

specifications/details/details.schema.json

 {
   "$id": "http://gov.uk/schema/v1.0.0/details",
   "_name": "details",
-  "title": "Details (progressive disclosure)",
-  "description": "Let users reveal more detailed information only if they need it",
+  "title": "Hide/reveal",
+  "description": "Let users reveal more information only if they need it (it‘s also known as ‘Details’ in the Design System)",
   "type": "object",
@@ -13,9 +13,11 @@ "properties": {
       "title": "Summary",
-      "description": "Text to use within the visible part of the details block",
-      "type": "string"
+      "description": "Text to use as the visible part of the component",
+      "type": "string",
+      "content": true
     },
     "html": {
       "title": "Content",
-      "description": "Text to use within the disclosed part of the details block",
+      "description": "Text to use as the hidden/revealed part of the component - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
       "type": "string",
+      "content": true,
       "multiline": true
@@ -25,3 +27,3 @@ },
       "title": "Open",
-      "description": "Whether details block should be expanded when the page loads",
+      "description": "Whether the component’s content should be revealed when the page loads",
       "type": "boolean",
@@ -28,0 +30,0 @@ "default": false

specifications/fieldset/fieldset.schema.json

@@ -17,3 +17,3 @@ {
       "title": "Legend",
-      "description": "Text to use in fieldset legend (legendHtml)",
+      "description": "Text to use in fieldset legend",
       "type": "string"
@@ -23,3 +23,3 @@ },
       "title": "Hint",
-      "description": "Hint text to use in fieldset legend (legendHintHtml)",
+      "description": "Text to help users answer a question - appears in grey under the legend",
       "type": "string"
@@ -26,0 +26,0 @@ }

specifications/fileupload/fileupload.schema.json

@@ -13,3 +13,3 @@ {
       "title": "Multiple files",
-      "description": "Whether multiple files can be uploaded",
+      "description": "Whether users can upload more than one file",
       "type": "boolean",
@@ -16,0 +16,0 @@ "default": false

specifications/group/group.schema.json

@@ -5,3 +5,3 @@ {
   "title": "Group",
-  "description": "Group components without semantic intent",
+  "description": "Group unrelated components",
   "type": "object",
@@ -8,0 +8,0 @@ "properties": {

specifications/inset/inset.schema.json

@@ -14,4 +14,5 @@ {
       "title": "Text",
-      "description": "Inset text content",
+      "description": "Inset text content - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
       "type": "string",
+      "content": true,
       "multiline": true
@@ -18,0 +19,0 @@ }

specifications/option/option.schema.json

@@ -12,5 +12,9 @@ {
     "text": {
+      "title": "Option text",
+      "description": "Text displayed to users for that option",
       "type": "string"
     },
     "value": {
+      "title": "Option value",
+      "description": "Value assigned when users select option",
       "type": "string"
@@ -17,0 +21,0 @@ }

specifications/page/content/page.content.schema.json

@@ -5,3 +5,3 @@ {
   "title": "Content",
-  "description": "Display content to the user without asking any questions",
+  "description": "Display content to users without asking any questions",
   "type": "object",
@@ -8,0 +8,0 @@ "properties": {

specifications/page/flashcard/page.flashcard.schema.json

@@ -5,3 +5,3 @@ {
   "title": "Flash card",
-  "description": "Display pre-amble information to users in a flash card",
+  "description": "Display information to users in a flash card, such as what they need to do before using a service",
   "type": "object",
@@ -8,0 +8,0 @@ "properties": {

specifications/page/form/page.form.schema.json

@@ -5,3 +5,3 @@ {
   "title": "Multiple questions",
-  "description": "Let users answer more than one question",
+  "description": "Ask users more than one question on a page",
   "type": "object",
@@ -8,0 +8,0 @@ "properties": {

specifications/page/singlequestion/page.singlequestion.schema.json

@@ -5,3 +5,3 @@ {
   "title": "Single question",
-  "description": "Let users answer a single question (can be repeatable)",
+  "description": "Ask users one question (you can make the question repeatable, so users can add additional answers)",
   "type": "object",
@@ -8,0 +8,0 @@ "properties": {

specifications/page/summary/page.summary.schema.json

@@ -5,3 +5,3 @@ {
   "title": "Check answers",
-  "description": "Let users check their answers before submitting",
+  "description": "Let users check and change their answers before submitting",
   "type": "object",
@@ -19,2 +19,3 @@ "properties": {
       "type": "string",
+      "content": true,
       "default": "Now send your application"
@@ -24,4 +25,5 @@ },
       "title": "Send content",
-      "description": "Content to display before accept and send button",
+      "description": "Content to display before accept and send button - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
       "type": "string",
+      "content": true,
       "multiline": true,
@@ -28,0 +30,0 @@ "default": "By submitting this application you confirm that, to the best of your knowledge, the details you are providing are correct."

specifications/panel/panel.schema.json

@@ -14,8 +14,10 @@ {
       "description": "Text to use as panel’s title",
-      "type": "string"
+      "type": "string",
+      "content": true
     },
     "html": {
       "title": "Content",
-      "description": "Text to use as panel’s content",
+      "description": "Text to use as panel’s content - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
       "type": "string",
+      "content": true,
       "multiline": true
@@ -22,0 +24,0 @@ }

specifications/radios/radios.schema.json

@@ -13,3 +13,3 @@ {
       "title": "Options",
-      "description": "Radio group options",
+      "description": "Items that users can select",
       "type": "array",
@@ -16,0 +16,0 @@ "items": {

specifications/section/section.schema.json

@@ -15,8 +15,14 @@ {
     "heading": {
+      "title": "Heading",
+      "description": "Appears at the top of the section as the correct level H element",
       "type": "string"
     },
     "lede": {
+      "title": "First paragraph",
+      "description": "Introductory paragraph for the section",
       "type": "string"
     },
     "content": {
+      "title": "Content",
+      "description": "Display ‘flat’ content, such as text",
       "type": "string",
@@ -23,0 +29,0 @@ "multiline": true

specifications/select/select.schema.json

@@ -5,3 +5,3 @@ {
   "title": "Select",
-  "description": "Let users select one option from a list. NB. use as a last resort",
+  "description": "Let users select one option from a list (only use as a last resort, as some users find selects difficult to use)",
   "type": "object",
@@ -14,3 +14,3 @@ "properties": {
       "title": "Options",
-      "description": "Select options",
+      "description": "Items that users can select",
       "type": "array",
@@ -17,0 +17,0 @@ "items": {

specifications/textarea/textarea.schema.json

@@ -5,3 +5,3 @@ {
   "title": "Textarea",
-  "description": "Let users enter text that’s longer than a single line",
+  "description": "Let users enter text that can be longer than a single line",
   "type": "object",
@@ -8,0 +8,0 @@ "properties": {

specifications/validations/validations.schema.json

@@ -12,3 +12,3 @@ {
           "title": "Input error",
-          "description": "Error message to display next to input",
+          "description": "Error message users see next to the input if their answer fails validation",
           "type": "string",
@@ -19,3 +19,3 @@ "role": "errorString"
           "title": "Summary error",
-          "description": "Error message to display in error summary header",
+          "description": "Error message users see at the top of a page if their answer fails validation - write {control} to show the question in the message",
           "type": "string",
@@ -28,2 +28,3 @@ "role": "errorString"
       "title": "Required",
+      "description": "Whether the user must answer a question",
       "oneOf": [
@@ -46,2 +47,3 @@ {
       "title": "Minimum length",
+      "description": "The minimum characters users must enter",
       "type": "number",
@@ -60,2 +62,3 @@ "minimum": 0
       "title": "Maximum length",
+      "description": "The maximum characters users can enter",
       "type": "number",
@@ -74,2 +77,3 @@ "minimum": 0
       "title": "Pattern to match string against",
+      "description": "A regular expression for validating users’ answers",
       "type": "string"
@@ -87,2 +91,3 @@ },
       "title": "Multiple of",
+      "description": "Whether users must enter a multiple of another number",
       "type": "number",
@@ -101,2 +106,3 @@ "minimum": 0
       "title": "Maximum value",
+      "description": "The largest number that users can enter",
       "type": "number",
@@ -114,3 +120,4 @@ "minimum": 0
     "exclusiveMaximum": {
-      "title": "Maximum value is exclusive",
+      "title": "Is maximum value exclusive?",
+      "description": "Excludes the maximum value from the range users can enter",
       "type": "boolean"
@@ -128,2 +135,3 @@ },
       "title": "Minimum value",
+      "description": "The smallest number that users can enter",
       "type": "number",
@@ -141,3 +149,4 @@ "minimum": 0
     "exclusiveMinimum": {
-      "title": "Minimum value is exclusive",
+      "title": "Is minimum value exclusive?",
+      "description": "Excludes the minimum value from the range users can enter",
       "type": "boolean"
@@ -144,0 +153,0 @@ },

specifications/warning/warning.schema.json

@@ -14,8 +14,10 @@ {
       "title": "Fallback text for the icon",
+      "description": "Alternative text for the icon - for example ‘warning’",
       "type": "string"
     },
     "html": {
-      "title": "Text",
-      "description": "Warning text content",
+      "title": "Content",
+      "description": "Warning text content - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
       "type": "string",
+      "content": true,
       "multiline": true
@@ -22,0 +24,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

114897

increased by4.05%

Lines of code

3371

increased by1.57%

No dependency changes