Readmes.

smeup · Jun 12, 2024 · bf4ebe0 · bf4ebe0
1 parent f807e44
commit bf4ebe0
Show file tree

Hide file tree

Showing 48 changed files with 1,201 additions and 815 deletions.
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ Ketchup repository is a monorepo multi-package repository managed with [Lerna](h
 
 ## Showcase
 
-Go to [Ketchup Showcase](http://ketchup.smeup.com) to see our components live.<p align="right">(<a href="#top">back to top</a>)</p>
+Go to [Ketchup Showcase](http://smeup.github.io/ketchup) to see our components live.<p align="right">(<a href="#top">back to top</a>)</p>
 
 ## Getting started
 

diff --git a/packages/ketchup-showcase/src/views/components/basic/iframe/examples/IframeDemo.vue b/packages/ketchup-showcase/src/views/components/basic/iframe/examples/IframeDemo.vue
@@ -80,7 +80,7 @@ function createComp() {
     flat: true,
   };
   comp.id = 'demo-component';
-  comp.src = 'https://ketchup.smeup.com';
+  comp.src = 'https://smeup.github.io/ketchup';
   return comp;
 }
 </script>
diff --git a/packages/ketchup/README.md b/packages/ketchup/README.md
@@ -54,7 +54,7 @@ Ketchup repository is a monorepo multi-package repository managed with [Lerna](h
 
 ## Showcase
 
-Go to [Ketchup Showcase](http://ketchup.smeup.com) to see our components live.<p align="right">(<a href="#top">back to top</a>)</p>
+Go to [Ketchup Showcase](http://smeup.github.io/ketchup) to see our components live.<p align="right">(<a href="#top">back to top</a>)</p>
 
 ## Getting started
 

diff --git a/packages/ketchup/src/assets/image-list.js b/packages/ketchup/src/assets/image-list.js
@@ -1029,7 +1029,7 @@ const data = [
             {
                 imageData: {
                     resource:
-                        'https://ketchup.smeup.com/ketchup-showcase/header_logo_dark.svg',
+                        'https://smeup.github.io/ketchup/ketchup-showcase/header_logo_dark.svg',
                     sizeX: '1.75rem',
                     sizeY: 'auto',
                     color: 'var(--kup-text-on-primary-color)',
@@ -1079,7 +1079,7 @@ const data = [
             {
                 imageData: {
                     resource:
-                        'https://ketchup.smeup.com/ketchup-showcase/header_logo_dark.svg',
+                        'https://smeup.github.io/ketchup/ketchup-showcase/header_logo_dark.svg',
                     sizeX: '1.75rem',
                     sizeY: 'auto',
                     color: 'var(--kup-text-on-primary-color)',

diff --git a/packages/ketchup/src/components/kup-accordion/readme.md b/packages/ketchup/src/components/kup-accordion/readme.md
@@ -2,21 +2,24 @@
 
 <!-- Auto Generated Below -->
 
+
 ## Properties
 
-| Property | Attribute | Description | Type | Default |
-| --- | --- | --- | --- | --- |
-| `customStyle` | `custom-style` | Custom style of the component. | `string` | `''` |
-| `data` | -- | Data of the accordion. | `KupAccordionData` | `null` |
-| `ripple` | `ripple` | When enabled displays Material's ripple effect on item headers. | `boolean` | `false` |
-| `sizing` | `sizing` | Sets the type of the button | `KupComponentSizing.LARGE \| KupComponentSizing.MAX \| KupComponentSizing.MEDIUM \| KupComponentSizing.SMALL` | `KupComponentSizing.MEDIUM` |
+| Property      | Attribute      | Description                                                     | Type                                                                                                          | Default                     |
+| ------------- | -------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------- |
+| `customStyle` | `custom-style` | Custom style of the component.                                  | `string`                                                                                                      | `''`                        |
+| `data`        | --             | Data of the accordion.                                          | `KupAccordionData`                                                                                            | `null`                      |
+| `ripple`      | `ripple`       | When enabled displays Material's ripple effect on item headers. | `boolean`                                                                                                     | `false`                     |
+| `sizing`      | `sizing`       | Sets the type of the button                                     | `KupComponentSizing.LARGE \| KupComponentSizing.MAX \| KupComponentSizing.MEDIUM \| KupComponentSizing.SMALL` | `KupComponentSizing.MEDIUM` |
+
 
 ## Events
 
-| Event | Description | Type |
-| --- | --- | --- |
+| Event                        | Description                     | Type                                                |
+| ---------------------------- | ------------------------------- | --------------------------------------------------- |
 | `kup-accordion-itemselected` | Fired when an item is selected. | `CustomEvent<KupAccordionItemSelectedEventPayload>` |
 
+
 ## Methods
 
 ### `collapseAll() => Promise<void>`
@@ -27,6 +30,8 @@ This method collapses all expandible items.
 
 Type: `Promise<void>`
 
+
+
 ### `expandAll() => Promise<void>`
 
 This method expands all expandible items.
@@ -35,14 +40,16 @@ This method expands all expandible items.
 
 Type: `Promise<void>`
 
+
+
 ### `getProps(descriptions?: boolean) => Promise<GenericObject>`
 
 Used to retrieve component's props values.
 
 #### Parameters
 
-| Name | Type | Description |
-| --- | --- | --- |
+| Name           | Type      | Description                                                                            |
+| -------------- | --------- | -------------------------------------------------------------------------------------- |
 | `descriptions` | `boolean` | - When provided and true, the result will be the list of props with their description. |
 
 #### Returns
@@ -59,20 +66,24 @@ This method is used to trigger a new render of the component.
 
 Type: `Promise<void>`
 
+
+
 ### `setProps(props: GenericObject) => Promise<void>`
 
 Sets the props to the component.
 
 #### Parameters
 
-| Name | Type | Description |
-| --- | --- | --- |
+| Name    | Type            | Description                                                  |
+| ------- | --------------- | ------------------------------------------------------------ |
 | `props` | `GenericObject` | - Object containing props that will be set to the component. |
 
 #### Returns
 
 Type: `Promise<void>`
 
+
+
 ### `toggleItem(itemName: string) => Promise<void>`
 
 This method activates or deactivates an item
@@ -87,35 +98,38 @@ This method activates or deactivates an item
 
 Type: `Promise<void>`
 
+
+
+
 ## CSS Custom Properties
 
-| Name | Description |
-| --- | --- |
-| `--kup-accordion-background-color` | Sets background of the component. |
-| `--kup-accordion-border` | Sets borders color of the accordion. |
-| `--kup-accordion-border-radius` | Sets border radius of the first and last items of the accordion. |
-| `--kup-accordion-dropdown-icon-color` | Sets color of the dropdown icon. |
-| `--kup-accordion-font-family` | Sets font family of the component. |
-| `--kup-accordion-font-size` | Sets font size of the component. |
-| `--kup-accordion-hover-background-color` | Sets background color of the hover effect. |
-| `--kup-accordion-hover-color` | Sets text color of the hover effect. |
-| `--kup-accordion-padding` | Sets padding of the accordion's items. |
-| `--kup-accordion-primary-color` | Sets primary color of the component. |
-| `--kup-accordion-primary-color-rgb` | Sets primary color RGB values of the component. |
-| `--kup-accordion-text-color` | Sets text color of the component. |
-| `--kup-accordion-text-on-primary-color` | Sets text on primary color of the component. |
-| `--kup-accordion-transition` | Sets transition duration for color and background-color. |
+| Name                                     | Description                                                      |
+| ---------------------------------------- | ---------------------------------------------------------------- |
+| `--kup-accordion-background-color`       | Sets background of the component.                                |
+| `--kup-accordion-border`                 | Sets borders color of the accordion.                             |
+| `--kup-accordion-border-radius`          | Sets border radius of the first and last items of the accordion. |
+| `--kup-accordion-dropdown-icon-color`    | Sets color of the dropdown icon.                                 |
+| `--kup-accordion-font-family`            | Sets font family of the component.                               |
+| `--kup-accordion-font-size`              | Sets font size of the component.                                 |
+| `--kup-accordion-hover-background-color` | Sets background color of the hover effect.                       |
+| `--kup-accordion-hover-color`            | Sets text color of the hover effect.                             |
+| `--kup-accordion-padding`                | Sets padding of the accordion's items.                           |
+| `--kup-accordion-primary-color`          | Sets primary color of the component.                             |
+| `--kup-accordion-primary-color-rgb`      | Sets primary color RGB values of the component.                  |
+| `--kup-accordion-text-color`             | Sets text color of the component.                                |
+| `--kup-accordion-text-on-primary-color`  | Sets text on primary color of the component.                     |
+| `--kup-accordion-transition`             | Sets transition duration for color and background-color.         |
+
 
 ## Dependencies
 
 ### Depends on
 
--   [kup-card](../kup-card)
--   [kup-dialog](../kup-dialog)
--   [kup-badge](../kup-badge)
+- [kup-card](../kup-card)
+- [kup-dialog](../kup-dialog)
+- [kup-badge](../kup-badge)
 
 ### Graph
-
 ```mermaid
 graph TD;
   kup-accordion --> kup-card
@@ -185,7 +199,6 @@ graph TD;
   kup-time-picker --> kup-list
   kup-time-picker --> kup-dialog
   kup-time-picker --> kup-badge
-  kup-image --> kup-spinner
   kup-image --> kup-card
   kup-image --> kup-image
   kup-image --> kup-dialog
@@ -276,6 +289,6 @@ graph TD;
   style kup-accordion fill:#f9f,stroke:#333,stroke-width:4px
 ```
 
----
+----------------------------------------------
 
-_Built with [StencilJS](https://stenciljs.com/)_
+*Built with [StencilJS](https://stenciljs.com/)*