fix: rename content prop to text and grammar edits

boltdesignsystem · Jan 23, 2020 · f5a4575 · f5a4575
1 parent cee5392
commit f5a4575
Show file tree

Hide file tree

Showing 14 changed files with 46 additions and 42 deletions.
diff --git a/docs-site/src/pages/pattern-lab/_patterns/02-components/toc.md b/docs-site/src/pages/pattern-lab/_patterns/02-components/toc.md
@@ -0,0 +1,3 @@
+---
+title: 'Table of Contents'
+---
diff --git a/docs-site/src/pages/pattern-lab/_patterns/02-components/toc/05-toc.twig b/docs-site/src/pages/pattern-lab/_patterns/02-components/toc/05-toc.twig
@@ -2,23 +2,23 @@
 {% include "@bolt-components-toc/toc.twig" with {
   items: [
     {
-      content: "Section One",
+      text: "Section One",
       url: "#section-one",
     },
     {
-      content: "Section Two",
+      text: "Section Two",
       url: "#section-two",
     },
     {
-      content: "Section Three",
+      text: "Section Three",
       url: "#section-three",
     },
     {
-      content: "Section Four",
+      text: "Section Four",
       url: "#section-four",
     },
     {
-      content: "Section Five",
+      text: "Section Five",
       url: "#section-five",
     },
   ]

diff --git a/...site/src/pages/pattern-lab/_patterns/02-components/toc/10-toc-item-active-variations.twig b/...site/src/pages/pattern-lab/_patterns/02-components/toc/10-toc-item-active-variations.twig
@@ -9,24 +9,24 @@
 {% include "@bolt-components-toc/toc.twig" with {
   items: [
     {
-      content: "Section One",
+      text: "Section One",
       url: "#section-one",
     },
     {
-      content: "Section Two",
+      text: "Section Two",
       url: "#section-two",
     },
     {
-      content: "Section Three",
+      text: "Section Three",
       url: "#section-three",
       active: true,
     },
     {
-      content: "Section Four",
+      text: "Section Four",
       url: "#section-four",
     },
     {
-      content: "Section Five",
+      text: "Section Five",
       url: "#section-five",
     },
   ]

diff --git a/docs-site/src/pages/pattern-lab/_patterns/02-components/toc/15-toc-header-variations.twig b/docs-site/src/pages/pattern-lab/_patterns/02-components/toc/15-toc-header-variations.twig
@@ -2,31 +2,31 @@
   Visible header
 </bolt-text>
 <bolt-text>
-  A header for a table of content can be created by passing plain text into the <bolt-code-snippet display="inline" lang="html">header</bolt-code-snippet> prop.
+  A header for table of contents can be created by passing plain text into the <bolt-code-snippet display="inline" lang="html">header</bolt-code-snippet> prop.
 </bolt-text>
 
 {# Start component specific code #}
 {% include "@bolt-components-toc/toc.twig" with {
   header: "This is the header",
   items: [
     {
-      content: "Section One",
+      text: "Section One",
       url: "#section-one",
     },
     {
-      content: "Section Two",
+      text: "Section Two",
       url: "#section-two",
     },
     {
-      content: "Section Three",
+      text: "Section Three",
       url: "#section-three",
     },
     {
-      content: "Section Four",
+      text: "Section Four",
       url: "#section-four",
     },
     {
-      content: "Section Five",
+      text: "Section Five",
       url: "#section-five",
     },
   ]

diff --git a/docs-site/src/pages/pattern-lab/_patterns/02-components/toc/20-toc-use-case-sticky.twig b/docs-site/src/pages/pattern-lab/_patterns/02-components/toc/20-toc-use-case-sticky.twig
@@ -7,15 +7,15 @@
           header: "Marvel Cinematic Universe",
           items: [
             {
-              content: "Phase One",
+              text: "Phase One",
               url: "#phase-one",
             },
             {
-              content: "Phase Two",
+              text: "Phase Two",
               url: "#phase-two",
             },
             {
-              content: "Phase Three",
+              text: "Phase Three",
               url: "#phase-three",
             },
           ]

diff --git a/docs-site/src/pages/pattern-lab/_patterns/02-components/toc/999-toc-with-web-component.twig b/docs-site/src/pages/pattern-lab/_patterns/02-components/toc/999-toc-with-web-component.twig
@@ -52,7 +52,7 @@
     Web Component Usage
   </bolt-text>
   <bolt-text>
-    Bolt Table of Content is a web component, you can simply use <bolt-code-snippet display="inline" lang="html">&lt;bolt-toc&gt;</bolt-code-snippet> in the markup to make it render.
+    Bolt Table of Contents is a web component, you can simply use <bolt-code-snippet display="inline" lang="html">&lt;bolt-toc&gt;</bolt-code-snippet> in the markup to make it render.
   </bolt-text>
   {% include toc_code.code_example(toc_demo) %}
 </div>

diff --git a/packages/components/bolt-toc/README.md b/packages/components/bolt-toc/README.md
@@ -1,6 +1,7 @@
-Table of Content is part of the collection of components, visual styles, and build tools that power the the [Bolt Design System](https://www.boltdesignsystem.com).
+Table of Contents is part of the collection of components, visual styles, and build tools that power the the [Bolt Design System](https://www.boltdesignsystem.com).
 
 ###### Install via NPM
+
 ```
 npm install @bolt/components-toc
 ```
diff --git a/packages/components/bolt-toc/__tests__/toc.js b/packages/components/bolt-toc/__tests__/toc.js
@@ -19,15 +19,15 @@ describe('<bolt-toc> Component', () => {
     const results = await render('@bolt-components-toc/toc.twig', {
       items: [
         {
-          content: 'Section One',
+          text: 'Section One',
           url: '#section-one',
         },
         {
-          content: 'Section Two',
+          text: 'Section Two',
           url: '#section-two',
         },
         {
-          content: 'Section Three',
+          text: 'Section Three',
           url: '#section-three',
         },
       ],
@@ -42,15 +42,15 @@ describe('<bolt-toc> Component', () => {
       header: 'This is the header',
       items: [
         {
-          content: 'Section One',
+          text: 'Section One',
           url: '#section-one',
         },
         {
-          content: 'Section Two',
+          text: 'Section Two',
           url: '#section-two',
         },
         {
-          content: 'Section Three',
+          text: 'Section Three',
           url: '#section-three',
         },
       ],
@@ -63,16 +63,16 @@ describe('<bolt-toc> Component', () => {
     const results = await render('@bolt-components-toc/toc.twig', {
       items: [
         {
-          content: 'Section One',
+          text: 'Section One',
           url: '#section-one',
         },
         {
-          content: 'Section Two',
+          text: 'Section Two',
           url: '#section-two',
           active: true,
         },
         {
-          content: 'Section Three',
+          text: 'Section Three',
           url: '#section-three',
         },
       ],

diff --git a/packages/components/bolt-toc/package.json b/packages/components/bolt-toc/package.json
@@ -1,14 +1,14 @@
 {
   "name": "@bolt/components-toc",
   "version": "0.0.0",
-  "description": "Table of Content is a navigation list, usually found on an article page, of its section titles.",
+  "description": "Table of Contents is a navigation list, usually found on an article page, of its section titles.",
   "keywords": [
     "bolt design system",
     "bolt",
     "css framework",
     "design system",
     "components",
-    "table of content"
+    "table of contents"
   ],
   "homepage": "https://boltdesignsystem.com",
   "bugs": "https://github.com/bolt-design-system/bolt/issues",

diff --git a/packages/components/bolt-toc/src/_toc-item.scss b/packages/components/bolt-toc/src/_toc-item.scss
@@ -1,5 +1,5 @@
 /* ------------------------------------ *\
-   Table of Content Item
+   Table of Contents Item
 \* ------------------------------------ */
 
 @import '@bolt/core-v3.x';

diff --git a/packages/components/bolt-toc/src/_toc-item.twig b/packages/components/bolt-toc/src/_toc-item.twig
@@ -39,12 +39,12 @@
 #}
 <bolt-toc-item
   {% if outer_classes %} class="{{ outer_classes|join(' ') }}" {% endif %}
-  {{ this.props|without("content")|without("class") }}
+  {{ this.props|without("text")|without("class") }}
   role="presentation"
 >
   <replace-with-grandchildren role="listitem">
     <a {% if inner_classes %} class="{{ inner_classes|join(' ') }}" {% endif %} href="{{ url }}">
-      {{ content }}
+      {{ text }}
     </a>
   </replace-with-grandchildren>
 </bolt-toc-item>
diff --git a/packages/components/bolt-toc/src/toc.js b/packages/components/bolt-toc/src/toc.js
@@ -80,7 +80,7 @@ class BoltToc extends withContext(BoltElement) {
           })}"
           id="js-bolt-toc-${this.uuid}"
         >
-          ${this.header ? this.header : 'Table of Content'}
+          ${this.header ? this.header : 'Table of Contents'}
         </h2>
         <div class="${cx(`c-bolt-toc__list`)}" role="list">
           ${this.slotify('default')}

diff --git a/packages/components/bolt-toc/src/toc.scss b/packages/components/bolt-toc/src/toc.scss
@@ -1,5 +1,5 @@
 /* ------------------------------------ *\
-   Table of Content
+   Table of Contents
 \* ------------------------------------ */
 
 @import '@bolt/core-v3.x';

diff --git a/packages/components/bolt-toc/toc.schema.js b/packages/components/bolt-toc/toc.schema.js
@@ -1,8 +1,8 @@
 module.exports = {
   $schema: 'http://json-schema.org/draft-04/schema#',
-  title: 'Table of Content',
+  title: 'Table of Contents',
   description:
-    'Table of Content is a navigation list, usually found on an article page, of its section titles.',
+    'A navigation list, usually found on an article page, of its section titles.',
   type: 'object',
   properties: {
     attributes: {
@@ -19,7 +19,7 @@ module.exports = {
         description:
           'Renders a linked item that points to the beginning of a particular section.',
         properties: {
-          content: {
+          text: {
             type: 'string',
             description: 'Renders the text for the linked item.',
           },
@@ -38,12 +38,12 @@ module.exports = {
     },
     header: {
       type: 'string',
-      description: 'Renders a header for the table of content.',
+      description: 'Renders a header for the table of contents.',
     },
     uuid: {
       type: 'string',
       description:
-        'Unique ID for the table of content, randomly generated if not provided.',
+        'Unique ID for the table of contents, randomly generated if not provided.',
     },
   },
 };