add time required field.

aem-design · Jun 2, 2021 · a692775 · a692775
1 parent 9580868
commit a692775
Show file tree

Hide file tree

Showing 5 changed files with 74 additions and 4 deletions.
diff --git a/.../apps/aemdesign/components/details/generic-details/v1/generic-details/README.md b/.../apps/aemdesign/components/details/generic-details/v1/generic-details/README.md
@@ -151,7 +151,32 @@ This component has the following variants
     </tbody>
 </table>
 
+# ISO 8601 duration format
 
+Time Required field uses ISO 8601 duration format and allows representing schema for an article or a page.
 
+Source: [ISO 8601 duration format](https://www.digi.com/resources/documentation/digidocs/90001437-13/reference/r_iso_8601_duration_format.htm)
+
+ISO 8601 Durations are expressed using the following format, where (n) is replaced by the value for each of the date and time elements that follow the (n):
+
+`P(n)Y(n)M(n)DT(n)H(n)M(n)S`
+
+Where:
+
+- `P` is the duration designator (referred to as "period"), and is always placed at the beginning of the duration.
+- `Y` is the year designator that follows the value for the number of years.
+- `M` is the month designator that follows the value for the number of months.
+- `W` is the week designator that follows the value for the number of weeks.
+- `D` is the day designator that follows the value for the number of days.
+- `T` is the time designator that precedes the time components.
+- `H` is the hour designator that follows the value for the number of hours.
+- `M` is the minute designator that follows the value for the number of minutes.
+- `S` is the second designator that follows the value for the number of seconds.
+
+For example:
+
+- `P3Y6M4DT12H30M5S` - Represents a duration of three years, six months, four days, twelve hours, thirty minutes, and five seconds.
+- `PT1M` - Represents a duration of time required to complete something which is one minute
+- `PT1H1M` - Represents a duration of time required to complete something which is one hour and one minute
 
 <p></p>
diff --git a/...s/aemdesign/components/details/generic-details/v1/generic-details/field/timerequired.html b/...s/aemdesign/components/details/generic-details/v1/generic-details/field/timerequired.html
@@ -0,0 +1,3 @@
+<template data-sly-template.field="${@ componentProperties}">
+  <span itemprop="timeRequired" content="${componentProperties.timeRequiredText}">${componentProperties.timeRequiredText}</span>
+</template>
diff --git a/...r_root/apps/aemdesign/components/details/news-details/v3/news-details/README.md b/...r_root/apps/aemdesign/components/details/news-details/v3/news-details/README.md
@@ -144,7 +144,32 @@ This component has the following variants
     </tbody>
 </table>
 
+# ISO 8601 duration format
 
+Time Required field uses ISO 8601 duration format and allows representing schema for an article or a page.
 
+Source: [ISO 8601 duration format](https://www.digi.com/resources/documentation/digidocs/90001437-13/reference/r_iso_8601_duration_format.htm)
 
-<p></p>
+ISO 8601 Durations are expressed using the following format, where (n) is replaced by the value for each of the date and time elements that follow the (n):
+
+  `P(n)Y(n)M(n)DT(n)H(n)M(n)S`
+
+Where:
+
+- `P` is the duration designator (referred to as "period"), and is always placed at the beginning of the duration.
+- `Y` is the year designator that follows the value for the number of years.
+- `M` is the month designator that follows the value for the number of months.
+- `W` is the week designator that follows the value for the number of weeks.
+- `D` is the day designator that follows the value for the number of days.
+- `T` is the time designator that precedes the time components.
+- `H` is the hour designator that follows the value for the number of hours.
+- `M` is the minute designator that follows the value for the number of minutes.
+- `S` is the second designator that follows the value for the number of seconds.
+
+For example:
+
+- `P3Y6M4DT12H30M5S` - Represents a duration of three years, six months, four days, twelve hours, thirty minutes, and five seconds.
+- `PT1M` - Represents a duration of time required to complete something which is one minute
+- `PT1H1M` - Represents a duration of time required to complete something which is one hour and one minute
+
+<p></p>
diff --git a/...ot/apps/aemdesign/components/details/news-details/v3/news-details/_cq_dialog/.content.xml b/...ot/apps/aemdesign/components/details/news-details/v3/news-details/_cq_dialog/.content.xml
@@ -105,6 +105,20 @@
                                 resourceType="granite/ui/components/foundation/form/hidden"
                                 sling:resourceType="granite/ui/components/coral/foundation/include"/>
 
+                            <timeRequired
+                                jcr:primaryType="nt:unstructured"
+                                jcr:title="Time Required / Time To Read Value"
+                                path="/apps/aemdesign/global/dialog/touch/page/content/items/pageBasicTab/items/column/items/metadata/items/timeRequired"
+                                resourceType="granite/ui/components/coral/foundation/form/textfield"
+                                sling:resourceType="granite/ui/components/coral/foundation/include"/>
+
+                            <timeRequiredText
+                                jcr:primaryType="nt:unstructured"
+                                jcr:title="Time Required / Time To Read Text"
+                                path="/apps/aemdesign/global/dialog/touch/page/content/items/pageBasicTab/items/column/items/metadata/items/timeRequiredText"
+                                resourceType="granite/ui/components/coral/foundation/form/textfield"
+                                sling:resourceType="granite/ui/components/coral/foundation/include"/>
+
                         </items>
                     </column2>
                 </items>

diff --git a/aemdesign-aem-services/src/main/java/design/aem/models/v2/details/GenericDetails.java b/aemdesign-aem-services/src/main/java/design/aem/models/v2/details/GenericDetails.java
@@ -15,15 +15,12 @@
 import org.apache.sling.api.SlingHttpServletRequest;
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ResourceResolver;
-import org.apache.sling.api.resource.ValueMap;
-import org.apache.sling.api.wrappers.ValueMapDecorator;
 import org.jsoup.Jsoup;
 import org.jsoup.nodes.Document;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.util.*;
-import java.util.stream.Collectors;
 
 import static design.aem.utils.components.CommonUtil.*;
 import static design.aem.utils.components.ComponentDetailsUtil.isComponentRenderedByList;
@@ -70,6 +67,10 @@ public class GenericDetails extends BaseComponent {
     protected static final String DEFAULT_TITLE_TAG_TYPE = "h1";
     protected static final String DEFAULT_I18N_LABEL = "variantHiddenLabel";
 
+    protected static final String FIELD_TIME_REQUIRED = "timeRequired";
+    protected static final String FIELD_TIME_REQUIRED_TEXT = "timeRequiredText";
+
+
     protected void ready() {
         componentProperties = ComponentsUtil.getComponentProperties(
             this,
@@ -166,6 +167,8 @@ protected void setFields() {
             {"showParsys", true},
             {FIELD_CONTENTFRAGMENT_VARIATION, DEFAULT_CONTENTFRAGMENT_VARIATION},
             {FIELD_CONTENTFRAGMENT_FRAGMENTPATH, StringUtils.EMPTY},
+            {FIELD_TIME_REQUIRED, StringUtils.EMPTY},
+            {FIELD_TIME_REQUIRED_TEXT, StringUtils.EMPTY},
         });
     }