Skip to content

Commit

Permalink
Made some spelling / grammar adjustments to the docs (#622)
Browse files Browse the repository at this point in the history
* Made some spelling / grammar adjustments to the docs

* Missed capitlization of a character
  • Loading branch information
tylergreulich authored and johnleider committed Oct 25, 2018
1 parent 7dc388a commit c99e4f3
Show file tree
Hide file tree
Showing 12 changed files with 41 additions and 38 deletions.
4 changes: 2 additions & 2 deletions src/lang/en/components/Alerts.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
},
"closable": {
"header": "Closable",
"desc": "Using `v-model` you can control the state of the Alert. If you don't want to assign a v-model and just display the alert, you can simply assign the prop `value`."
"desc": "Using `v-model`, you can control the state of the Alert. If you don't want to assign a v-model and just display the alert, you can simply assign the prop `value`."
},
"icon": {
"header": "Custom Icon / No Icon",
"desc": "You can easily assign a custom icon or remove it all together."
"desc": "You can easily assign a custom icon or remove it altogether."
},
"transition": {
"header": "Display transition",
Expand Down
2 changes: 1 addition & 1 deletion src/lang/en/components/Carousels.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
},
"hideControls": {
"header": "Hide controls",
"desc": "You can hide the navigtion controls with the `hide-controls` prop.",
"desc": "You can hide the navigation controls with the `hide-controls` prop.",
"uninverted": true
}
},
Expand Down
2 changes: 1 addition & 1 deletion src/lang/en/components/Combobox.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"examples": {
"combobox": {
"header": "Combobox",
"desc": "With combobox you can allow a user to create new values that may not be present in a provided items list."
"desc": "With Combobox, you can allow a user to create new values that may not be present in a provided items list."
},
"noData": {
"header": "No data with chips",
Expand Down
8 changes: 5 additions & 3 deletions src/lang/en/components/Dialogs.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,18 @@
}
},
"props": {
"disabled": "Disabled the ability to open the dialog",
"dark": "Mixins.Themeable.props.dark",
"disabled": "Disables the ability to open the dialog",
"fullWidth": "Specifies the modal to force 100% width",
"fullscreen": "Changes layout for fullscreen display",
"hideOverlay": "Hide the display of the overlay",
"hideOverlay": "Hides the display of the overlay",
"lazy": "Mixins.Bootable.props.lazy",
"light": "Mixins.Themeable.props.light",
"maxWidth": "The maximum width of the content",
"noClickAnimation": "Disables the bounce effect when clicking outside of a `v-dialog`'s content when using the **persistent** prop",
"origin": "Mixins.Transitionable.props.origin",
"persistent": "Clicking outside will not dismiss the dialog",
"scrollable": "When set to true, expects a card, card-title, card-text and card-actions. Additionally card-text should have specified height. Will set card-text to overflow-y",
"scrollable": "When set to true, expects a card, card-title, card-text and card-actions. Additionally, card-text should have specified height. Will set card-text to overflow-y",
"transition": "Mixins.Transitionable.props.transition",
"width": "Sets the dialog width"
}
Expand Down
28 changes: 14 additions & 14 deletions src/lang/en/components/ExpansionPanels.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"header": "Expansion Panel",
"headerText": "The `v-expansion-panel` component is useful for reducing vertical space with large amounts of information. The default functionality of the component is to only display one expansion-panel body at a time, however, with the `expand` property, the expansion-panel can remain open until explicitly closed.",
"headerText": "The `v-expansion-panel` component is useful for reducing vertical space with large amounts of information. The default functionality of the component is to only display one expansion-panel body at a time; however, with the `expandable` property, the expansion-panel can remain open until explicitly closed.",
"examples": {
"accordion": {
"header": "Accordion",
"desc": "Accordion expansion panels can only have 1 panel open at a time."
"desc": "Accordion expansion-panels can only have 1 panel open at a time."
},
"expand": {
"header": "Expand",
"desc": "Expand expansion panels will stay open until closed. When providing a model, any value not specified will be interpreted at false.",
"desc": "Expand expansion-panels will stay open until closed. When providing a model, any value not specified will be interpreted as false.",
"uninverted": true
},
"external": {
Expand All @@ -17,11 +17,11 @@
},
"disabledAndReadonly": {
"header": "Disabled and readonly",
"desc": "Both the expansion panel and its content supports the `disabled` and `readonly` props."
"desc": "Both the expansion-panel and its content supports the `disabled` and `readonly` props."
},
"popout": {
"header": "Popout & Inset",
"desc": "The expansion panel also has two alternative designs you can activate with the props `popout` and `inset`.",
"desc": "The expansion-panel also has two alternative designs you can activate with the props `popout` and `inset`.",
"inverted": true
},
"customIcons": {
Expand All @@ -30,25 +30,25 @@
},
"focusable": {
"header": "Focusable",
"desc": "The expansion panel headers can be made focusable with the prop `focusable`.",
"desc": "The expansion-panel headers can be made focusable with the prop `focusable`.",
"uninverted": true
}
},
"props": {
"v-expansion-panel": {
"disabled": "Disables entire expansion panel",
"expand": "Leaves expansion-panel open when selecting another",
"focusable": "Makes the expansion panel headers focusable",
"inset": "Makes the expansion panel open with a inset style",
"popout": "Makes the expansion panel open with an popout style",
"readonly": "Makes entire expansion panel read only.",
"disabled": "Disables the entire expansion-panel",
"expand": "Leaves the expansion-panel open while selecting another",
"focusable": "Makes the expansion-panel headers focusable",
"inset": "Makes the expansion-panel open with a inset style",
"popout": "Makes the expansion-panel open with an popout style",
"readonly": "Makes the entire expansion-panel read only.",
"value": "Controls the opened/closed state of content in the expansion-panel. Corresponds to a zero-based index of the currently opened content. If `expand` prop is used then it is an array of booleans where the index corresponds to the index of the content."
},
"v-expansion-panel-content": {
"disabled": "Disables expansion panel content",
"disabled": "Disables the expansion-panel content",
"expandIcon": "Set the expand action icon",
"hideActions": "Hide the expand icon in the content header",
"readonly": "Makes expansion panel content read only.",
"readonly": "Makes the expansion-panel content read only.",
"value": "Controls the opened/closed state of content"
}
},
Expand Down
4 changes: 2 additions & 2 deletions src/lang/en/components/Icons.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
"props": {
"disabled": "Components.Inputs.props.disabled",
"large": "Mixins.Sizeable.props.large",
"left": "Places icon on the left, when used inside a button",
"left": "Places the icon on the left, when used inside a button",
"medium": "Mixins.Sizeable.props.medium",
"right": "Places icon on the right, when used inside a button",
"right": "Places the icon on the right, when used inside a button",
"size": "Mixins.Sizeable.props.size",
"small": "Mixins.Sizeable.props.small",
"xLarge": "Mixins.Sizeable.props.xLarge"
Expand Down
8 changes: 4 additions & 4 deletions src/lang/en/components/Images.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"examples": {
"containCover": {
"header": "Contain and Cover",
"desc": "If the provided aspect ratio doesn't match that of the actual image, the default behaviour is to fill as much space as possible, clipping the sides of the image. Enabling the `contain` prop will prevent this, but will result in empty space at the sides."
"desc": "If the provided aspect ratio doesn't match that of the actual image, the default behavior is to fill as much space as possible, clipping the sides of the image. Enabling the `contain` prop will prevent this, but will result in empty space at the sides."
},
"maxHeight": {
"header": "Height",
Expand All @@ -21,10 +21,10 @@
"props": {
"alt": "Alternate text for screen readers. Leave empty for decorative images",
"aspectRatio": "Calculated as `width/height`, so for a 1920x1080px image this will be `1.7778`. Will be calculated automatically if omitted",
"contain": "Prevent the image from being cropped if it doesn't fit",
"gradient": "Overlay a gradient onto the image. Only supports [linear-gradient](https://developer.mozilla.org/en-US/docs/Web/CSS/linear-gradient) syntax, anything else should be done with classes (see examples)",
"contain": "Prevents the image from being cropped if it doesn't fit",
"gradient": "Overlays a gradient onto the image. Only supports [linear-gradient](https://developer.mozilla.org/en-US/docs/Web/CSS/linear-gradient) syntax, anything else should be done with classes (see examples)",
"lazySrc": "Something to show while waiting for the main image to load, typically a small base64-encoded thumbnail. Has a slight blur filter applied.\n\nUse [vuetify-loader](https://github.com/vuetifyjs/vuetify-loader) to generate automatically",
"position": "Override the default to change which parts get cropped off. Uses the same syntax as [`background-position`](https://developer.mozilla.org/en-US/docs/Web/CSS/background-position)",
"position": "Overrides the default to change which parts get cropped off. Uses the same syntax as [`background-position`](https://developer.mozilla.org/en-US/docs/Web/CSS/background-position)",
"sizes": "For use with `srcset`, see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes)",
"src": "The image URL. This prop is mandatory",
"srcset": "A set of alternate images to use based on device size. [Read more...](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-srcset)",
Expand Down
7 changes: 4 additions & 3 deletions src/lang/en/components/Inputs.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,19 @@
}
}],
"props": {
"appendIcon": "Append an icon to the component, uses same syntax as `v-icon`",
"appendIcon": "Appends an icon to the component, uses the same syntax as `v-icon`",
"appendIconCb": "Callback for appended icon when clicked",
"backgroundColor": "Changes the background-color of the input",
"disabled": "Input is disabled",
"hideDetails": "Hides hint, validation errors",
"hint": "Hint text",
"label": "Sets input label",
"persistentHint": "Forces hint to always be visible",
"placeholder": "Sets the input's placeholder text",
"prependIcon": "Prepend an icon to the component, uses same syntax as `v-icon`",
"prependIcon": "Prepends an icon to the component, uses the same syntax as `v-icon`",
"prependIconCb": "Callback for prepended icon when clicked",
"readonly": "Puts input in readonly state",
"required": "Designates the input as required. Adds an asertisk to end of label. Does not perform any validation.",
"required": "Designates the input as required; Adds an asertisk to the end of the label; Does not perform any validation.",
"tabindex": "Tabindex of input",
"toggleKeys": "Array of key codes that will toggle the input (if it supports toggling)",
"value": "Input value"
Expand Down
10 changes: 5 additions & 5 deletions src/lang/en/components/TextFields.json
Original file line number Diff line number Diff line change
Expand Up @@ -89,24 +89,24 @@
}
},
"props": {
"appendOuterIcon": "Append an icon to the outside of `v-text-field`'s input, uses same syntax as `v-icon`",
"appendOuterIcon": "Appends an icon to the outside of `v-text-field`'s input, uses same syntax as `v-icon`",
"appendOuterIconCb": "Callback for appended outer icon when clicked",
"autoGrow": "Auto-grows the input. This option requires the use of **v-model**",
"autofocus": "Enable autofocus",
"autofocus": "Enables autofocus",
"box": "Applies the alternate box input style",
"browserAutocomplete": "Configures the default `<input>` autocomplete attribute",
"clearIcon": "Applied when using **clearable** and the input is dirty",
"clearIconCb": "Callback for clear icon when clicked",
"counter": "Creates counter for input length. If no Number is specified, it defaults to 25. Does not apply any validation.",
"counter": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.",
"flat": "Mixins.Soloable.props.flat",
"fullWidth": "Desginates input type as full-width",
"multiLine": "Turns into textarea",
"noResize": "Remove resize handle, only applies to **multi-line** and **textarea** props",
"noResize": "Removes the resize handle, only applies to **multi-line** and **textarea** props",
"outline": "Applies the outline style to the input",
"placeholder": "Sets the input’s placeholder text",
"prefix": "Displays prefix text",
"reverse": "Reverses the input orientation",
"rows": "Number of rows in textarea",
"rows": "Controls the number of rows in a textarea",
"rowHeight": "Designate a custom _row-height_. Used for determining input height when using **multi-line** or **textarea** props",
"solo": "Mixins.Soloable.props.solo",
"soloInverted": "Mixins.Soloable.props.soloInverted",
Expand Down
2 changes: 1 addition & 1 deletion src/lang/en/directives/Scrolling.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"examples": {
"default": {
"header": "Default",
"desc": "The default behavior is to bind to the window. If no additional configuration options are needed, you can simple pass your callback function.",
"desc": "The default behavior is to bind to the window. If no additional configuration options are needed, you can simply pass your callback function.",
"uninverted": true
},
"options": {
Expand Down
2 changes: 1 addition & 1 deletion src/lang/en/mixins/Sizeable.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"props": {
"large": "Makes the icon large **(36px)**",
"medium": "Makes the icon medium **(28px)**",
"size": "Specify a custom font size for the icon",
"size": "Specifies a custom font size for the icon",
"small": "Makes the icon small **(16px)**",
"xLarge": "Makes the icon extra large **(40px)**"
}
Expand Down
2 changes: 1 addition & 1 deletion src/lang/en/mixins/Validatable.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"errorCount": "The total number of errors that should display at once",
"errorMessages": "Puts the input in an error state and passes through custom error messsages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation",
"messages": "Displays a list of messages or message if using a string",
"rules": "Array of functions that return either True or a String with an error message",
"rules": "Accepts an array of functions that return either True or a String with an error message",
"success": "Puts the input in a manual success state",
"successMessages": "Puts the input in a success state and passes through custom success messsages.",
"validateOnBlur": "Delays validation until blur event"
Expand Down

0 comments on commit c99e4f3

Please sign in to comment.