@mapvx/web-components-ssr 1.6.1 → 1.7.0-dev.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,13 +1,15 @@
1
1
  # MapVX Website Component
2
2
 
3
- A modern, framework-agnostic web component built with Angular 20 that provides an interactive map and location discovery interface.
3
+ A modern, framework-agnostic web component built with Angular 22 that provides an interactive map and location discovery interface.
4
+
5
+ 📖 **Documentation (Spanish and English): https://docs.mapvx.app/ssr-angular-component/**
4
6
 
5
7
  ## 🚀 Features
6
8
 
7
9
  - ✅ Compatible with any framework (React, Vue, Vanilla JS, etc.)
8
- - ✅ Self-contained and isolated (Shadow DOM)
9
- - ✅ Optimized bundle without hashing for production
10
- - ✅ Angular 20 with modern architecture (standalone components)
10
+ - ✅ Self-contained: one ES module (`main.js`, which lazy-loads its `chunk-*.js` files) plus one stylesheet
11
+ - ✅ Scoped styles: renders in the light DOM (no Shadow DOM), with Angular's emulated style encapsulation
12
+ - ✅ Angular 22 with modern architecture (standalone components, zoneless)
11
13
  - 🔑 **Requires API Key**: The component needs a valid API key to function
12
14
 
13
15
  ## 📦 Installation
@@ -245,19 +247,23 @@ export class MyComponent {
245
247
 
246
248
  The web component accepts the following input properties to customize its behavior:
247
249
 
248
- | Property | Type | Required | Default | Description |
249
- | ----------------------- | --------- | ---------- | ------------------------------- | ------------------------------------------------------------------------------------------------- |
250
- | `api-key` | `string` | ✅ **Yes** | - | Valid API key to initialize the SDK |
251
- | `institution-id` | `string` | ✅ **Yes** | - | Institution ID for specific data filtering and search |
252
- | `initial-data` | `string` | ❌ No | - | JSON string with initial data (use `prepareInitialData` from `@mapvx/web-components-ssr-helpers`) |
253
- | `default-to-map` | `boolean` | ❌ No | `false` | If `true`, shows map view by default |
254
- | `show-category-filters` | `boolean` | ❌ No | `true` | If `true`, shows category filters |
255
- | `show-city-filter` | `boolean` | ❌ No | `true` | If `true`, shows city filter |
256
- | `inherit-font-family` | `boolean` | ❌ No | `false` | If `true`, inherits font family from parent |
257
- | `hide-deals` | `boolean` | ❌ No | `false` | If `true`, hides deals and promotional content |
258
- | `show-deal-labels` | `boolean` | ❌ No | `false` | If `true`, shows deal labels over their images on the home screen |
259
- | `card-width` | `number` | ❌ No | `237` (desktop), `170` (mobile) | Custom card width in pixels for grid view. Affects card size and number of cards per row |
260
- | `rows-per-page` | `number` | ❌ No | `2` | Maximum number of rows per page (1-10). Shows fewer rows if not enough cards to fill all rows |
250
+ | Property | Type | Required | Default | Description |
251
+ | ------------------------- | --------- | ---------- | ------------------------------- | ------------------------------------------------------------------------------------------------- |
252
+ | `api-key` | `string` | ✅ **Yes** | - | Valid API key to initialize the SDK |
253
+ | `institution-id` | `string` | ✅ **Yes** | - | Institution ID for specific data filtering and search |
254
+ | `initial-data` | `string` | ❌ No | - | JSON string with initial data (use `prepareInitialData` from `@mapvx/web-components-ssr-helpers`) |
255
+ | `default-to-map` | `boolean` | ❌ No | `false` | If `true`, shows map view by default |
256
+ | `show-category-filters` | `boolean` | ❌ No | `true` | If `true`, shows category filters |
257
+ | `show-city-filter` | `boolean` | ❌ No | `true` | If `true`, shows city filter |
258
+ | `show-view-toggle` | `boolean` | ❌ No | `true` | If `true`, shows the Grid View / Map View toggle |
259
+ | `show-search-bar` | `boolean` | ❌ No | `true` | If `true`, shows the search bar |
260
+ | `full-width-map` | `boolean` | ❌ No | `false` | If `true`, the map fills the width in map view and the card list beside it is hidden |
261
+ | `hide-unselected-markers` | `boolean` | ❌ No | `false` | If `true`, while a place profile is open only that place's marker stays on the map |
262
+ | `inherit-font-family` | `boolean` | ❌ No | `false` | If `true`, inherits font family from parent |
263
+ | `hide-deals` | `boolean` | ❌ No | `false` | If `true`, hides deals and promotional content |
264
+ | `show-deal-labels` | `boolean` | ❌ No | `false` | If `true`, shows deal labels over their images on the home screen |
265
+ | `card-width` | `number` | ❌ No | `237` (desktop), `170` (mobile) | Custom card width in pixels for grid view. Affects card size and number of cards per row |
266
+ | `rows-per-page` | `number` | ❌ No | `2` | Maximum number of rows per page (1-10). Shows fewer rows if not enough cards to fill all rows |
261
267
 
262
268
  ### Input Usage Examples
263
269