eclipsefdn-hugo-solstice-theme 0.0.166 → 0.0.168

package/exampleSite/config/_default/menus.en.toml

@@ -183,6 +183,18 @@
     weight = 3
     parent = "solstice"
 
+[[main]]
+    name = "Twitter Timeline"
+    url = "/components/twitter_timeline/"
+    weight = 3
+    parent = "solstice"
+
+[[main]]
+    name = "Twitter Buttons"
+    url = "/components/twitter_button/"
+    weight = 3
+    parent = "solstice"
+
 [[main]]
     name = "RSS Feed"
     url = "/components/rss/"

package/exampleSite/content/components/twitter_button.md

@@ -0,0 +1,54 @@
+---
+title: "Twitter Buttons"
+date: 2019-04-17T15:52:27-04:00
+description: ""
+categories: []
+keywords: []
+slug: ""
+aliases: []
+toc: false
+draft: false
+---
+
+A shortcode wrapper for the [Twitter button embeds](https://developer.twitter.com/en/docs/twitter-for-websites).
+
+---
+
+## Follow Button
+A button to follow a Twitter profile. To display this type of button, set the `type` parameter to `"follow"`.
+
+{{< twitter_button type="follow" >}}
+
+### Set Handle*
+The Twitter handle can be set from the site's config.toml file or by using the `handle` parameter.
+
+{{< twitter_button type="follow" handle="EclipseCon" >}}
+
+### Size Property*
+The `size` parameter can be set to "default" or "large".
+
+{{< twitter_button type="follow" size="large" >}}
+
+### Show Follower Count
+The follower count can be toggled using the `hide_followers` parameter.
+
+{{< twitter_button type="follow" hide_followers="false" >}}
+
+{{< grid/div class="sideitem margin-top-20" >}}
+**\* Note:** These parameters also apply to the Mention Button and Hashtag Button types.  
+{{</ grid/div >}}
+
+---
+
+## Mention Button
+A button to tweet to a profile. The profile is set using the `handle` parameter. This can be omitted if the Twitter handle is specified in config.toml. 
+
+{{< twitter_button type="mention" >}}
+
+---
+
+## Hashtag Button
+A button to tweet with a hashtag. The hashtag can be set using the `hashtag` parameter.
+
+{{< twitter_button type="hashtag" hashtag="eclipsecon" >}}
+

package/exampleSite/content/components/twitter_timeline.md

@@ -0,0 +1,27 @@
+---
+title: "Twitter Timeline"
+date: 2019-04-17T15:52:27-04:00
+description: ""
+categories: []
+keywords: []
+slug: ""
+aliases: []
+toc: false
+draft: false
+---
+
+A shortcode wrapper for the [Twitter timeline embeds](https://developer.twitter.com/en/docs/twitter-for-websites).
+
+{{< twitter_timeline tweet_limit="2" >}}
+
+### Dark Mode Enabled
+Dark mode can be enabled by setting the `dark` parameter to `"true"`.
+
+{{< twitter_timeline dark="true" tweet_limit="2" >}}
+
+### Tweet Limits
+The maximum number of tweets displayed can be controlled using the `tweet_limit` parameter.
+
+In the following example, we set the `tweet_limit` to `"1"`.
+
+{{< twitter_timeline tweet_limit="1" >}}

package/layouts/partials/footer_js.html

@@ -1,45 +1,49 @@
+<div id="footer-js">
+  <!-- Placed at the end of the document so the pages load faster -->
+  {{- with .Site.Params.js | default "https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/main.min.js"}}
+  <script src="{{ . | relURL }}?v={{ now.Unix }}"></script>
+  {{ end }}
 
-<!-- Placed at the end of the document so the pages load faster -->
-{{- with .Site.Params.js | default "https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/main.min.js"}}
-<script src="{{ . | relURL }}?v={{ now.Unix }}"></script>
-{{ end }}
+  {{- with .Site.Params.hugo_js }}
+    <script src="{{ . | relURL }}"></script>
+  {{ end }}
 
-{{- with .Site.Params.hugo_js }}
-  <script src="{{ . | relURL }}"></script>
-{{ end }}
+  <!-- Read in mustache templates registered in page scratch -->
+  {{ range $key, $value := (.Page.Scratch.Get "mustache-templates") }}
+  <script id="{{ $key }}" type="text/html">
+  {{ readFile $value | safeHTML}}
+  </script>
+  {{ end }}
 
+  <!-- Initialize any newsroom components on the page -->
+  <script>
+  (function($, document) {
+    {{ range (.Page.Scratch.Get "events-container-ids") }}
+      $("#{{ . }}").eclipseFdnApi({
+        type: "filteredEvents"
+      });
+    {{ end }}
+    {{ range (.Page.Scratch.Get "news-container-ids") }}
+      $("#{{ . }}").eclipseFdnApi({
+        type: "newsItems"
+      });
+    {{ end }}
+  })(jQuery, document);
+  </script>
 
-<!-- Read in mustache templates registered in page scratch -->
-{{ range $key, $value := (.Page.Scratch.Get "mustache-templates") }}
-<script id="{{ $key }}" type="text/html">
-{{ readFile $value | safeHTML}}
-</script>
-{{ end }}
+  <script>
+    (function (eclipseFdnAdopters) {
+      if (typeof eclipsefdn_adopters_configs !== 'undefined') {
+        eclipseFdnAdopters.getWGList({
+          src_root: 'https://api.eclipse.org/adopters',
+          working_group: eclipsefdn_adopters_configs.working_group,
+          ul_classes: eclipsefdn_adopters_configs.ul_classes,
+        });
+      }
+    })(eclipseFdnAdopters);
+  </script>
 
-<!-- Initialize any newsroom components on the page -->
-<script>
-(function($, document) {
-  {{ range (.Page.Scratch.Get "events-container-ids") }}
-    $("#{{ . }}").eclipseFdnApi({
-      type: "filteredEvents"
-    });
-  {{ end }}
-  {{ range (.Page.Scratch.Get "news-container-ids") }}
-    $("#{{ . }}").eclipseFdnApi({
-      type: "newsItems"
-    });
+  {{ if eq (.Page.Scratch.Get "is_using_twitter") "true" }}
+    <script src="https://platform.twitter.com/widgets.js" async></script>
   {{ end }}
-})(jQuery, document);
-</script>
-
-<script>
-  (function (eclipseFdnAdopters) {
-    if (typeof eclipsefdn_adopters_configs !== 'undefined') {
-      eclipseFdnAdopters.getWGList({
-        src_root: 'https://api.eclipse.org/adopters',
-        working_group: eclipsefdn_adopters_configs.working_group,
-        ul_classes: eclipsefdn_adopters_configs.ul_classes,
-      });
-    }
-  })(eclipseFdnAdopters);
-</script>
+</div>

package/layouts/shortcodes/twitter_button.html

@@ -0,0 +1,44 @@
+{{ $class := .Get "class" | default "" }}
+{{ $type := .Get "type" }}
+{{ $handle := .Get "handle" | default .Site.Author.twitter }}
+{{ $hide_followers := .Get "hide_followers" | default "true" }}
+{{ $hashtag := .Get "hashtag" }}
+{{ $preload_text := .Get "preload_text" }}
+{{ $size := .Get "size" | default "default" }}
+
+{{ if not $type }}
+    {{ errorf "A type must be provided to display a Twitter button from twitter_button.html" }}
+{{ end }}
+
+{{ $type_map := dict "follow" "twitter-follow-button" "mention" "twitter-mention-button" "hashtag" "twitter-hashtag-button" }}
+{{ $twitter_class := index $type_map $type | default false }}
+
+{{ if not $twitter_class }}
+    {{ errorf "Invalid type shortcode parameter value provided to twitter_button.html" }}
+{{ else if and (eq $type "follow") (not $handle) }}
+    {{ errorf "A handle must be provided to display a Twitter follow button from twitter_button.html" }}
+{{ else if and (eq $type "hashtag") (not $hashtag) }}
+    {{ errorf "A hashtag must be provided to display a Twitter hashtag button from twitter_button.html"}}
+{{ end }}
+
+{{ $href := "https://twitter.com/" }}
+{{ if eq $type "follow" }}
+    {{ $href = printf "%s%s" $href $handle }}
+{{ else if eq $type "mention" }}
+    {{ $href = printf "%s%s%s" $href "/intent/tweet?screen_name=" $handle }}
+{{ else if eq $type "hashtag" }}
+    {{ $href = printf "%s%s%s" $href "/intent/tweet?button_hashtag=" $hashtag }}
+{{ end }}
+
+<div class="eclipsefdn-twitter-button eclipsefdn-twitter-button-{{- $type -}} {{ $class }}">
+    <a class="eclipsefdn-twitter-button-preloaded eclipsefdn-twitter-button-{{- $type -}}-preloaded {{ $twitter_class }}"
+        href="{{ $href }}"    
+        data-dnt="true"
+        data-size="{{ $size }}"
+        {{ if eq $hide_followers "true" }} data-show-count="false" {{ end }}
+    >
+        {{ $preload_text }}
+    </a>
+</div>
+
+{{ .Page.Scratch.Set "is_using_twitter" "true" }}

package/layouts/shortcodes/twitter_timeline.html

@@ -0,0 +1,20 @@
+{{ $class := .Get "class" }}
+{{ $handle := .Get "handle" | default .Site.Author.twitter }}
+{{ $dark := .Get "dark" | default "" }}
+{{ $tweet_limit := .Get "tweet_limit" | default "20" }}
+
+{{ if not $handle }}
+    {{ errorf "A handle must be provided to display a Twitter timeline from twitter_timeline.html" }}
+{{ end }}
+
+<div class="eclipsefdn-twitter-timeline {{ $class }}">
+    <a class="eclipsefdn-twitter-timeline-preloaded twitter-timeline" 
+        href="https://twitter.com/{{ $handle }}" 
+        {{- if $dark -}} data-theme="dark" {{ end }} 
+        data-tweet-limit="{{ $tweet_limit }}" 
+        data-dnt="true">
+            Follow @{{ $handle }}
+    </a>
+</div>
+
+{{ .Page.Scratch.Set "is_using_twitter" "true" }}

package/package.json

@@ -4,7 +4,7 @@
   "main": "webpack.min.js",
   "author": "Christopher Guindon",
   "license": "EPL-2.0",
-  "version": "0.0.166",
+  "version": "0.0.168",
   "bugs": {
     "url": "https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-solstice-theme/-/issues"
   },
@@ -24,7 +24,7 @@
   "readmeFilename": "README.md",
   "dependencies": {
     "axios": "^0.21.1",
-    "eclipsefdn-solstice-assets": "^0.0.206",
+    "eclipsefdn-solstice-assets": "^0.0.207",
     "json2yaml": "^1.1.0",
     "toml": "^3.0.0"
   },

package/webpack.mix.js

@@ -28,4 +28,4 @@ mix.js(
   './static/js/solstice.js'
 );
 
-mix.js(['./node_modules/eclipsefdn-solstice-assets/js/solstice/eclipsefdn.projects.js'], './static/js/eclipsefdn.projects.js');
+mix.js(['./node_modules/eclipsefdn-solstice-assets/js/solstice/eclipsefdn.projects.js'], './static/js/eclipsefdn.projects.js');