Skip to content

Commit

Permalink
update components readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bastyen committed Feb 16, 2024
1 parent 11317d6 commit 169a56f
Show file tree
Hide file tree
Showing 21 changed files with 475 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/components/grw-common-button/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@
| `name` | `name` | | `string` | `undefined` |


## Shadow Parts

| Part | Description |
| ----------------------- | ----------- |
| `"common-button"` | |
| `"common-button-icon"` | |
| `"common-button-label"` | |


## Dependencies

### Used by
Expand Down
9 changes: 9 additions & 0 deletions src/components/grw-extended-fab/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@
| `name` | -- | | `Function` | `undefined` |


## Shadow Parts

| Part | Description |
| ------------------------------- | ----------- |
| `"map-visibility-button"` | |
| `"map-visibility-button-icon"` | |
| `"map-visibility-button-label"` | |


## Dependencies

### Used by
Expand Down
12 changes: 12 additions & 0 deletions src/components/grw-filter/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,18 @@
| `segment` | `segment` | | `string` | `undefined` |


## Shadow Parts

| Part | Description |
| --------------------------- | ----------- |
| `"filter-button"` | |
| `"filter-button-container"` | |
| `"filter-label"` | |
| `"filter-name"` | |
| `"filter-select"` | |
| `"selected-filter-icon"` | |


## Dependencies

### Used by
Expand Down
21 changes: 21 additions & 0 deletions src/components/grw-filters/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,27 @@
| `resetFilter` | | `CustomEvent<any>` |


## Shadow Parts

| Part | Description |
| ---------------------------------------- | ----------- |
| `"back-filters-container"` | |
| `"current-treks-within-bounds-length"` | |
| `"filter-container"` | |
| `"filter-option-button"` | |
| `"filters-container"` | |
| `"filters-options-buttons-container"` | |
| `"filters-options-container"` | |
| `"filters-segment-container"` | |
| `"filters-touristic-contents-container"` | |
| `"filters-touristic-events-container"` | |
| `"filters-treks-container"` | |
| `"options-container"` | |
| `"segment"` | |
| `"segment-container"` | |
| `"segmented-buttons-container"` | |


## Dependencies

### Used by
Expand Down
19 changes: 19 additions & 0 deletions src/components/grw-information-desk/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,25 @@
| `centerOnMap` | | `CustomEvent<{ latitude: number; longitude: number; }>` |


## Shadow Parts

| Part | Description |
| ------------------------------------------ | ----------- |
| `"center-on-map-button"` | |
| `"handle-information-desk-description"` | |
| `"icon"` | |
| `"information-desk-description"` | |
| `"information-desk-description-container"` | |
| `"information-desk-img"` | |
| `"information-desk-img-container"` | |
| `"information-desk-informations"` | |
| `"information-desk-name"` | |
| `"information-desk-sub-container"` | |
| `"label"` | |
| `"link-container"` | |
| `"mail-container"` | |


## Dependencies

### Used by
Expand Down
7 changes: 7 additions & 0 deletions src/components/grw-loader/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@
| `colorPrimaryContainer` | `color-primary-container` | | `string` | `'#eaddff'` |


## Shadow Parts

| Part | Description |
| ---------- | ----------- |
| `"loader"` | |


## Dependencies

### Used by
Expand Down
11 changes: 11 additions & 0 deletions src/components/grw-map/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,17 @@
| `trekCardPress` | | `CustomEvent<number>` |


## Shadow Parts

| Part | Description |
| ------------------------ | ----------- |
| `"elevation"` | |
| `"loader"` | |
| `"map"` | |
| `"map-bottom-space"` | |
| `"map-loader-container"` | |


## Dependencies

### Used by
Expand Down
20 changes: 20 additions & 0 deletions src/components/grw-poi-detail/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,26 @@
| `poi` | -- | | `{ id: number; name: string; description: string; attachments: Attachments; type: number; geometry: Geometry; }` | `undefined` |


## Shadow Parts

| Part | Description |
| -------------------------- | ----------- |
| `"default-poi-img"` | |
| `"handle-poi-description"` | |
| `"poi-description"` | |
| `"poi-img"` | |
| `"poi-name"` | |
| `"poi-sub-container"` | |
| `"poi-type"` | |
| `"poi-type-img-container"` | |
| `"swiper-button-next"` | |
| `"swiper-button-prev"` | |
| `"swiper-pagination"` | |
| `"swiper-poi"` | |
| `"swiper-slide"` | |
| `"swiper-wrapper"` | |


## Dependencies

### Used by
Expand Down
8 changes: 8 additions & 0 deletions src/components/grw-search/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@
| `fontFamily` | `font-family` | | `string` | `'Roboto'` |


## Shadow Parts

| Part | Description |
| ---------------- | ----------- |
| `"icon"` | |
| `"search-input"` | |


## Dependencies

### Used by
Expand Down
8 changes: 8 additions & 0 deletions src/components/grw-segmented-segment/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@
| `treks` | `treks` | | `boolean` | `true` |


## Shadow Parts

| Part | Description |
| ------------------------------- | ----------- |
| `"segment"` | |
| `"segmented-buttons-container"` | |


## Dependencies

### Used by
Expand Down
9 changes: 9 additions & 0 deletions src/components/grw-select-language/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@
<!-- Auto Generated Below -->


## Shadow Parts

| Part | Description |
| -------------------------- | ----------- |
| `"select-language-icon"` | |
| `"select-language-option"` | |
| `"select-language-select"` | |


## Dependencies

### Used by
Expand Down
21 changes: 21 additions & 0 deletions src/components/grw-sensitive-area-detail/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,27 @@
| `sensitiveArea` | -- | | `{ id: number; geometry: Geometry; name: string; description: string; contact: string; info_url: string; period: boolean[]; practices: number[]; }` | `undefined` |


## Shadow Parts

| Part | Description |
| ------------------------------------- | ----------- |
| `"sensitive-area-color-container"` | |
| `"sensitive-area-contact-container"` | |
| `"sensitive-area-contact-title"` | |
| `"sensitive-area-contact-value"` | |
| `"sensitive-area-description"` | |
| `"sensitive-area-period"` | |
| `"sensitive-area-period-container"` | |
| `"sensitive-area-period-title"` | |
| `"sensitive-area-periods"` | |
| `"sensitive-area-practice"` | |
| `"sensitive-area-practice-container"` | |
| `"sensitive-area-practice-title"` | |
| `"sensitive-area-practices"` | |
| `"sensitive-area-title"` | |
| `"sensitive-area-title-container"` | |


## Dependencies

### Used by
Expand Down
23 changes: 23 additions & 0 deletions src/components/grw-touristic-content-card/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,29 @@
| `touristicContentCardPress` | | `CustomEvent<number>` |


## Shadow Parts

| Part | Description |
| ------------------------------------------- | ----------- |
| `"default-touristic-content-img"` | |
| `"more-details-button"` | |
| `"swiper-button-next"` | |
| `"swiper-button-prev"` | |
| `"swiper-pagination"` | |
| `"swiper-slide"` | |
| `"swiper-touristic-content"` | |
| `"swiper-wrapper"` | |
| `"touristic-content-card"` | |
| `"touristic-content-category-container"` | |
| `"touristic-content-category-img"` | |
| `"touristic-content-category-name"` | |
| `"touristic-content-img"` | |
| `"touristic-content-img-container"` | |
| `"touristic-content-more-detail-container"` | |
| `"touristic-content-name"` | |
| `"touristic-content-sub-container"` | |


## Dependencies

### Used by
Expand Down
49 changes: 49 additions & 0 deletions src/components/grw-touristic-content-detail/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,55 @@
| `isLargeView` | `is-large-view` | | `boolean` | `false` |


## Shadow Parts

| Part | Description |
| ---------------------------------------- | ----------- |
| `"cities"` | |
| `"cities-container"` | |
| `"cities-title"` | |
| `"close-fullscreen-button"` | |
| `"contact"` | |
| `"contact-container"` | |
| `"contact-title"` | |
| `"default-poi-img"` | |
| `"description"` | |
| `"description-container"` | |
| `"description-teaser"` | |
| `"description-title"` | |
| `"detail-bottom-space"` | |
| `"divider"` | |
| `"download-title"` | |
| `"downloads-container"` | |
| `"email"` | |
| `"email-container"` | |
| `"email-title"` | |
| `"icon"` | |
| `"image"` | |
| `"images-container"` | |
| `"label"` | |
| `"legend-container"` | |
| `"link-container"` | |
| `"links-container"` | |
| `"name"` | |
| `"swiper-button-next"` | |
| `"swiper-button-prev"` | |
| `"swiper-images"` | |
| `"swiper-pagination"` | |
| `"swiper-slide"` | |
| `"swiper-wrapper"` | |
| `"touristic-content-category-container"` | |
| `"touristic-content-category-img"` | |
| `"touristic-content-category-name"` | |
| `"touristic-content-detail-container"` | |
| `"useful-information"` | |
| `"useful-information-container"` | |
| `"useful-information-title"` | |
| `"website"` | |
| `"website-container"` | |
| `"website-title"` | |


## Dependencies

### Used by
Expand Down
9 changes: 9 additions & 0 deletions src/components/grw-touristic-contents-list/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@
| `isLargeView` | `is-large-view` | | `boolean` | `false` |


## Shadow Parts

| Part | Description |
| --------------------------------------------------- | ----------- |
| `"current-touristic-contents-within-bounds-length"` | |
| `"list-bottom-space"` | |
| `"touristic-contents-list-container"` | |


## Dependencies

### Used by
Expand Down
25 changes: 25 additions & 0 deletions src/components/grw-touristic-event-card/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,31 @@
| `touristicEventCardPress` | | `CustomEvent<number>` |


## Shadow Parts

| Part | Description |
| ----------------------------------------- | ----------- |
| `"default-touristic-event-img"` | |
| `"more-details-button"` | |
| `"swiper-button-next"` | |
| `"swiper-button-prev"` | |
| `"swiper-pagination"` | |
| `"swiper-slide"` | |
| `"swiper-touristic-event"` | |
| `"swiper-wrapper"` | |
| `"touristic-event-card"` | |
| `"touristic-event-date"` | |
| `"touristic-event-date-container"` | |
| `"touristic-event-img"` | |
| `"touristic-event-img-container"` | |
| `"touristic-event-more-detail-container"` | |
| `"touristic-event-name"` | |
| `"touristic-event-sub-container"` | |
| `"touristic-event-type-container"` | |
| `"touristic-event-type-img"` | |
| `"touristic-event-type-name"` | |


## Dependencies

### Used by
Expand Down
Loading

0 comments on commit 169a56f

Please sign in to comment.