@penskemediacorp/larva-patterns 1.77.1 → 1.79.0

package/modules/google-preferred-button/README.md

@@ -0,0 +1,29 @@
+# google-preferred-button
+
+A module that renders a Google Preferred Source button — a linked call-to-action allowing readers to add the site as a Google Preferred Source.
+
+## Data contract
+
+| Key | Type | Required | Description |
+|-----|------|----------|-------------|
+| `google_preferred_button_url` | string | No | Destination URL. Defaults to `https://www.google.com/preferences/source?q=<home_url>` via controller. |
+| `google_preferred_button_classes` | string | No | Additional modifier classes on the root `<a>`. |
+| `google_preferred_button_icon_url` | string | No | If set, renders an `<img>` with this URL. If empty, falls back to `c-icon` (sprite). |
+| `google_preferred_button_icon_classes` | string | No | Additional classes on the `<img>` icon element. |
+| `c_icon` | object | No | Passed to `c-icon` component when no `icon_url` is set. Defaults to `google-preferred` sprite icon. |
+| `c_span` | object | No | Passed to `c-span` component for the button label. |
+
+## Icon strategy
+
+- **Default (sprite):** Uses the `google-preferred` SVG from `@penskemediacorp/larva-svg`.
+- **Brand override:** Pass `icon_url` from the controller to render a brand-specific raster image via `<img>`.
+
+## Controller entry point
+
+`PMC\Larva\Controllers\Modules\Google_Preferred_Button` in the `pmc-larva` plugin.
+
+The controller re-injects `label_text` via `C_Span` after mock-stripping removes the prototype `_text` value.
+
+## Theme-level styling
+
+The base module ships no CSS. Brands should add their own one-off stylesheet scoped to a brand modifier class (e.g. `o-google-preferred-button--rs`).

package/modules/google-preferred-button/google-preferred-button.prototype.js

@@ -0,0 +1,28 @@
+const clonedeep = require( 'lodash.clonedeep' );
+
+const c_icon = clonedeep(
+	require( '@penskemediacorp/larva-patterns/components/c-icon/c-icon.prototype' )
+);
+const c_span = clonedeep(
+	require( '@penskemediacorp/larva-patterns/components/c-span/c-span.prototype' )
+);
+
+c_icon.c_icon_name = 'google-preferred';
+c_icon.c_icon_screen_reader_text = '';
+c_icon.c_icon_screen_reader_title_attr = '';
+c_icon.c_icon_screen_reader_tag_text = '';
+c_icon.c_icon_link_screen_reader_text = 'Icon Link';
+c_icon.c_icon_link_classes = '';
+c_icon.c_icon_url = false;
+
+c_span.c_span_classes = 'u-font-family-basic';
+c_span.c_span_text = 'Add us as a Google Preferred Source';
+c_span.c_span_url = false;
+
+module.exports = {
+	google_preferred_button_classes: 'lrv-u-flex lrv-u-align-items-center',
+	google_preferred_button_icon_url: '',
+	google_preferred_button_icon_classes: '',
+	c_icon,
+	c_span,
+};

package/modules/google-preferred-button/google-preferred-button.twig

@@ -0,0 +1,9 @@
+<button class="o-google-preferred-button {{ google_preferred_button_classes }}" aria-label="Add us as a Google Preferred Source" data-track data-track-category="Article" data-track-action="Google Preferred Source" data-track-label="Click">
+	{% if google_preferred_button_icon_url %}
+		<img src="{{ google_preferred_button_icon_url }}" alt="" aria-hidden="true" class="o-google-preferred-button__icon {{ google_preferred_button_icon_classes }}">
+	{% else %}
+		{% include "@larva/components/c-icon/c-icon.twig" with c_icon %}
+	{% endif %}
+
+	{% include "@larva/components/c-span/c-span.twig" with c_span %}
+</button>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@penskemediacorp/larva-patterns",
-  "version": "1.77.1",
+  "version": "1.79.0",
   "description": "Larva markup patterns.",
   "author": "laras126 <laras126@gmail.com>",
   "homepage": "https://github.com/Penske-Media-Corp/pmc-larva/tree/master/packages/patterns#readme",
@@ -20,10 +20,10 @@
     "url": "https://github.com/Penske-Media-Corp/pmc-larva/issues"
   },
   "dependencies": {
-    "@penskemediacorp/larva-css": "^1.77.1",
-    "@penskemediacorp/larva-js": "^1.77.1",
-    "@penskemediacorp/larva-svg": "^1.77.1",
+    "@penskemediacorp/larva-css": "^1.79.0",
+    "@penskemediacorp/larva-js": "^1.79.0",
+    "@penskemediacorp/larva-svg": "^1.79.0",
     "lodash.clonedeep": "^4"
   },
-  "gitHead": "d93ba925282cc2e2c0ac78768b1c7cb5e457ed0b"
+  "gitHead": "39d2e12edc65e6e554b2e8c2856bf242a392cbe7"
 }