diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index 4b35df35a80..9f6aee225c1 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -1737,6 +1737,8 @@ entries: nested: - title: "Autocomplete" url: /docs/scos/dev/front-end-development/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: "Button Action" + url: /docs/scos/dev/front-end-development/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: "Chip" url: /docs/scos/dev/front-end-development/marketplace/table-design/table-column-type-extension/table-column-type-chip.html - title: "Date" @@ -1799,6 +1801,8 @@ entries: nested: - title: "Close Drawer" url: /docs/scos/dev/front-end-development/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: "Confirmation" + url: /docs/scos/dev/front-end-development/marketplace/ui-components-library/actions/actions-confirmation.html - title: "Drawer" url: /docs/scos/dev/front-end-development/marketplace/ui-components-library/actions/actions-drawer.html - title: "HTTP" diff --git a/_includes/pbc/all/install-features/202403.0/install-the-category-management-feature.md b/_includes/pbc/all/install-features/202403.0/install-the-category-management-feature.md new file mode 100644 index 00000000000..37e79aca594 --- /dev/null +++ b/_includes/pbc/all/install-features/202403.0/install-the-category-management-feature.md @@ -0,0 +1,1334 @@ + + +This document describes how to install the [Category Management](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/category-management-feature-overview.html) feature. + +## Install feature core + +Follow the steps below to install the Category Management feature core. + +### Prerequisites + +Install the required feature: + +| NAME | VERSION | INSTALLATION GUIDE | +|--------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Install the Spryker Core feature](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-feature-integration.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/category-management:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|----------------------|---------------------------------------| +| Category | vendor/spryker/category | +| CategoryDataFeed | vendor/spryker/category-data-feed | +| CategoryDataImport | vendor/spryker/category-data-import | +| CategoryExporter | vendor/spryker/category-exporter | +| CategoryGui | vendor/spryker/category-gui | +| CategoryPageSearch | vendor/spryker/category-page-search | +| CategoryStorage | vendor/spryker/category-storage | +| CategoryGuiExtension | vendor/spryker/category-gui-extension | +| CategoryImage | vendor/spryker/category-image | +| CategoryImageGui | vendor/spryker/category-image-gui | +| CategoryImageStorage | vendor/spryker/category-image-storage | +| CategoryExtension | vendor/spryker/category-extension | + +{% endinfo_block %} + +### 2) Set up configuration + +Set up the following configuration: + +**src/Pyz/Zed/CategoryImageStorage/CategoryImageStorageConfig.php** + +```php + new SynchronizationStorageQueueMessageProcessorPlugin(), + CategoryPageSearchConstants::CATEGORY_SYNC_SEARCH_QUEUE => new SynchronizationSearchQueueMessageProcessorPlugin(), + ]; + } +} +``` + +### 3) Set up database schema and transfer objects + +1. Adjust the schema definition so that entity changes trigger the events: + +**src/Pyz/Zed/Category/Persistence/Propel/Schema/spy_category.schema.xml** + +```xml + + + + + + + +
+ + + + + +
+ + + + + + +
+ + + + + +
+ + + + + +
+ +
+``` + +**src/Pyz/Zed/CategoryImage/Persistence/Propel/Schema/spy_category_image.schema.xml** + +```xml + + + + + + + +
+ + + + + +
+ + + + + +
+
+``` + +2. Set up synchronization queue pools, so entities without store relations are synchronized among stores: + +**src/Pyz/Zed/CategoryImageStorage/Persistence/Propel/Schema/spy_category_image_storage.schema.xml** + +```xml + + + + + + + +
+
+``` + +3. Apply database changes and generate entity and transfer changes: + +```bash +console propel:install +console transfer:generate +``` + +{% info_block warningBox "Verification" %} + +* Make sure the following changes have been applied in the database: + +| DATABASE ENTITY | TYPE | EVENT | +|------------------------------------------|-------|---------| +| spy_category | table | created | +| spy_category_attribute | table | created | +| spy_category_closure_table | table | created | +| spy_category_node | table | created | +| spy_category_store | table | created | +| spy_category_template | table | created | +| spy_category_node_storage | table | created | +| spy_category_node_page_search | table | created | +| spy_category_tree_storage | table | created | +| spy_category_image_set | table | created | +| spy_category_image | table | created | +| spy_category_image_set_to_category_image | table | created | +| spy_category_image_storage | table | created | + +* Make sure propel entities have been generated successfully by checking their existence. + +{% endinfo_block %} + +4. Change the generated entity classes to extend from the core classes. + +| CLASS PATH | EXTENDS | +|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------| +| src/Orm/Zed/Category/Persistence/Base/SpyCategory.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategory | +| src/Orm/Zed/Category/Persistence/Base/SpyCategoryAttribute.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategoryAttribute | +| src/Orm/Zed/Category/Persistence/Base/SpyCategoryClosureTable.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategoryClosureTable | +| src/Orm/Zed/Category/Persistence/Base/SpyCategoryNode.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategoryNode | +| src/Orm/Zed/Category/Persistence/Base/SpyCategoryStore.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategoryStore | +| src/Orm/Zed/Category/Persistence/Base/SpyCategoryTemplate.php | Spryker\Zed\Category\Persistence\Propel\AbstractSpyCategoryTemplate | +| src/Orm/Zed/CategoryPageSearch/Persistence/Base/SpyCategoryNodePageSearch.php | Spryker\Zed\CategoryPageSearch\Persistence\Propel\AbstractSpyCategoryNodePageSearch | +| src/Orm/Zed/CategoryStorage/Persistence/Base/SpyCategoryNodeStorage.php | Spryker\Zed\CategoryStorage\Persistence\Propel\AbstractSpyCategoryNodeStorage | +| src/Orm/Zed/CategoryStorage/Persistence/Base/SpyCategoryTreeStorage.php | Spryker\Zed\CategoryStorage\Persistence\Propel\AbstractSpyCategoryTreeStorage | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImage.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImage | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageQuery.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImageQuery | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSet.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImageSet | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSetQuery.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImageSetQuery | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSetToCategoryImage.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImageSetToCategoryImage | +| src/Orm/Zed/CategoryImage/Persistence/Base/SpyCategoryImageSetToCategoryImageQuery.php | Spryker\Zed\CategoryImage\Persistence\Propel\AbstractSpyCategoryImageSetToCategoryImageQuery | +| src/Orm/Zed/CategoryImageStorage/Persistence/Base/SpyCategoryImageStorage.php | Spryker\Zed\CategoryImageStorage\Persistence\Propel\AbstractSpyCategoryImageStorage | +| src/Orm/Zed/CategoryImageStorage/Persistence/Base/SpyCategoryImageStorageQuery.php | Spryker\Zed\CategoryImageStorage\Persistence\Propel\AbstractSpyCategoryImageStorageQuery | + +{% info_block warningBox "Verification" %} + +Make sure that the following changes have been implemented in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|-------------------------------------------|-------|---------|------------------------------------------------------------------------------| +| CategoryCollectionTransfer | class | created | src/Generated/Shared/Transfer/CategoryCollectionTransfer.php | +| CategoryCriteriaTransfer | class | created | src/Generated/Shared/Transfer/CategoryCriteriaTransfer.php | +| CategoryDataFeedTransfer | class | created | src/Generated/Shared/Transfer/CategoryDataFeedTransfer.php | +| CategoryImageSetCollectionStorageTransfer | class | created | src/Generated/Shared/Transfer/CategoryImageSetCollectionStorageTransfer.php | +| CategoryImageSetStorageTransfer | class | created | src/Generated/Shared/Transfer/CategoryImageSetStorageTransfer.php | +| CategoryImageSetTransfer | class | created | src/Generated/Shared/Transfer/CategoryImageSetTransfer.php | +| CategoryImageStorageTransfer | class | created | src/Generated/Shared/Transfer/CategoryImageStorageTransfer.php | +| CategoryImageTransfer | class | created | src/Generated/Shared/Transfer/CategoryImageTransfer.php | +| CategoryLocalizedAttributesTransfer | class | created | src/Generated/Shared/Transfer/CategoryLocalizedAttributesTransfer.php | +| CategoryMapTransfer | class | created | src/Generated/Shared/Transfer/CategoryMapTransfer.php | +| CategoryNodeAggregationTransfer | class | created | src/Generated/Shared/Transfer/CategoryNodeAggregationTransfer.php | +| CategoryNodeCriteriaTransfer | class | created | src/Generated/Shared/Transfer/CategoryNodeCriteriaTransfer.php | +| CategoryNodeFilterTransfer | class | created | src/Generated/Shared/Transfer/CategoryNodeFilterTransfer.php | +| CategoryNodePageSearchTransfer | class | created | src/Generated/Shared/Transfer/CategoryNodePageSearchTransfer.php | +| CategoryNodeSearchResultTransfer | class | created | src/Generated/Shared/Transfer/CategoryNodeSearchResultTransfer.php | +| CategoryNodeStorageTransfer | class | created | src/Generated/Shared/Transfer/CategoryNodeStorageTransfer.php | +| CategoryNodeUrlCriteriaTransfer | class | created | src/Generated/Shared/Transfer/CategoryNodeUrlCriteriaTransfer.php | +| CategoryNodeUrlPathCriteriaTransfer | class | created | src/Generated/Shared/Transfer/CategoryNodeUrlPathCriteriaTransfer.php | +| CategoryResponseTransfer | class | created | src/Generated/Shared/Transfer/CategoryResponseTransfer.php | +| CategoryTemplateTransfer | class | created | src/Generated/Shared/Transfer/CategoryTemplateTransfer.php | +| CategoryTransfer | class | created | src/Generated/Shared/Transfer/CategoryTransfer.php | +| CategoryTreeStorageTransfer | class | created | src/Generated/Shared/Transfer/CategoryTreeStorageTransfer.php | +| NodeCollectionTransfer | class | created | src/Generated/Shared/Transfer/NodeCollectionTransfer.php | +| NodeTransfer | class | created | src/Generated/Shared/Transfer/NodeTransfer.php | +| UpdateCategoryStoreRelationRequest | class | created | src/Generated/Shared/Transfer/UpdateCategoryStoreRelationRequestTransfer.php | +| CategoryNodeCollectionRequest | class | created | src/Generated/Shared/Transfer/CategoryNodeCollectionRequestTransfer.php | +| CategoryNodeCollectionResponse | class | created | src/Generated/Shared/Transfer/CategoryNodeCollectionResponseTransfer.php | +| ErrorCollection | class | created | src/Generated/Shared/Transfer/ErrorCollectionTransfer.php | +| Error | class | created | src/Generated/Shared/Transfer/ErrorTransfer.php | + +{% endinfo_block %} + +### 4) Add translations + +1. Append glossary according to your configuration: + +**src/data/import/glossary.csv** +```csv +category.validation.category_node_entity_not_found,The category node ID '%category_node_id%' cannot be relocated because this category node no longer exists.,en_US +category.validation.category_node_entity_not_found,"Die Kategorieknoten-ID '%category_node_id%' kann nicht verschoben werden, da dieser Kategorieknoten nicht mehr existiert.",de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure the configured data has been added to the `spy_glossary` table. + +{% endinfo_block %} + +3. Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +{% info_block warningBox "Verification" %} + +Make sure that the Back Office navigation related to categories has been translated. + +{% endinfo_block %} + +### 5) Set up search + +Add the page map plugin for the *category node* entity. + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|--------------------------------|---------------------------------------------------|---------------|------------------------------------------------------------| +| CategoryNodeDataPageMapBuilder | Builds the page map for the category node entity. | | Spryker\Zed\CategoryPageSearch\Communication\Plugin\Search | + + +**src/Pyz/Zed/Search/SearchDependencyProvider.php** + +```php + +src/Pyz/Zed/Publisher/PublisherDependencyProvider.php + +```php +getCategoryStoragePlugins(), + $this->getCategoryPageSearchPlugins(), + ); + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface[] + */ + protected function getCategoryStoragePlugins(): array + { + return [ + new CategoryStoreStorageWritePublisherPlugin(), + new CategoryStoreStorageWriteForPublishingPublisherPlugin(), + new CategoryTreeWriteForPublishingPublisherPlugin(), + new CategoryDeletePublisherPlugin(), + new CategoryStoreCategoryWritePublisherPlugin(), + new CategoryAttributeDeletePublisherPlugin(), + new CategoryAttributeWritePublisherPlugin(), + new CategoryNodeDeletePublisherPlugin(), + new CategoryNodeWritePublisherPlugin(), + new CategoryTemplateDeletePublisherPlugin(), + new CategoryTemplateWritePublisherPlugin(), + new CategoryTreeDeletePublisherPlugin(), + new ParentWritePublisherPlugin(), + ]; + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface[] + */ + protected function getCategoryPageSearchPlugins(): array + { + return [ + new CategoryStoreSearchWritePublisherPlugin(), + new CategoryStoreSearchWriteForPublishingPublisherPlugin(), + new CategoryPageSearchCategoryDeletePublisherPlugin(), + new CategoryPageSearchCategoryWritePublisherPlugin(), + new CategoryPageSearchCategoryAttributeDeletePublisherPlugin(), + new CategoryPageSearchCategoryAttributeWritePublisherPlugin(), + new CategoryPageSearchCategoryNodeDeletePublisherPlugin(), + new CategoryPageSearchCategoryNodeWritePublisherPlugin(), + new CategoryPageSearchCategoryTemplateDeletePublisherPlugin(), + new CategoryPageSearchCategoryTemplateWritePublisherPlugin(), + ]; + } +} +``` + + +2. Set up event listeners: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------|---------------|------------------------------------------------------------------------| +| CategoryImageStorageEventSubscriber | Registers listeners that are responsible for publishing category image information to storage when a related entity changes. | | Spryker\Zed\CategoryImageStorage\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new CategoryImageStorageEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +3. Set up trigger plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|------------------------------------|------------------------------------------------------------------|---------------|---------------------------------------------------------------| +| CategoryNodePublisherTriggerPlugin | Retrieves category nodes based on the provided limit and offset. | | Spryker\Zed\CategoryStorage\Communication\Plugin\Publisher | +| CategoryTreePublisherTriggerPlugin | Retrieves category trees based on the provided limit and offset. | | Spryker\Zed\CategoryStorage\Communication\Plugin\Publisher | +| CategoryPagePublisherTriggerPlugin | Retrieves category nodes based on the provided limit and offset. | | Spryker\Zed\CategoryPageSearch\Communication\Plugin\Publisher | + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php +getPublisherTriggerPlugins(), + ); + } + + /** + * @return \Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface[] + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new CategoryNodePublisherTriggerPlugin(), + new CategoryTreePublisherTriggerPlugin(), + new CategoryPagePublisherTriggerPlugin(), + ]; + } +} +``` + +4. Set up synchronization plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|---------------|-----------------------------------------------------------------------| +| CategoryNodeSynchronizationDataBulkRepositoryPlugin | Retrieves a category node storage collection based on the provided offset, limit, and IDs. | | Spryker\Zed\CategoryStorage\Communication\Plugin\Synchronization | +| CategoryTreeSynchronizationDataBulkRepositoryPlugin | Retrieves a category tree storage collection based on the provided offset, limit, and `categoryTreeStorageId` values. | | Spryker\Zed\CategoryStorage\Communication\Plugin\Synchronization | +| CategoryPageSynchronizationDataBulkRepositoryPlugin | Retrieves a collection of synchronization data based on the provided offset, limit, and IDs. | | Spryker\Zed\CategoryPageSearch\Communication\Plugin\Synchronization | +| CategoryImageSynchronizationDataBulkPlugin | Synchronizes all category image entries from the database to Redis. | | Spryker\Zed\CategoryImageStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php +EXAMPLE EXPECTED DATA FRAGMENT: category_node:de:de_de:5 + +```yaml +{ + "id_category": 5, + "node_id": 5, + "name": "Computer", + "url": "/de/computer", + "is_active": true, + "template_path": "@CatalogPage/views/simple-cms-block/simple-cms-block.twig", + "order": 100, + "meta_title": "Computer", + "meta_description": "Computer", + "meta_keywords": "Computer", + "parents": [ + { + "id_category": 1, + "node_id": 1, + "name": "Demoshop", + "url": "/de", + "is_active": true, + "template_path": "@CatalogPage/views/catalog/catalog.twig", + "meta_title": "Demoshop", + "meta_description": "Deutsche Version des Demoshop", + "meta_keywords": "Deutsche Version des Demoshop" + } + ], + "children": [ + { + "id_category": 6, + "node_id": 6, + "name": "Notebooks", + "url": "/de/computer/notebooks", + "is_active": true, + "template_path": "@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig", + "order": 100, + "meta_title": "Notebooks", + "meta_description": "Notebooks", + "meta_keywords": "Notebooks" + }, + { + "id_category": 7, + "node_id": 7, + "name": "Pc's/Workstations", + "url": "/de/computer/pc's/workstations", + "is_active": true, + "template_path": "@CatalogPage/views/catalog/catalog.twig", + "order": 90, + "meta_title": "Pc's/Workstations", + "meta_description": "Pc's/Workstations", + "meta_keywords": "Pc's/Workstations" + }, + { + "id_category": 8, + "node_id": 8, + "name": "Tablets", + "url": "/de/computer/tablets", + "is_active": true, + "template_path": "@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig", + "order": 80, + "meta_title": "Tablets", + "meta_description": "Tablets", + "meta_keywords": "Tablets" + } + ], + "_timestamp": 1621934332.368688 +} +``` + + +
+ EXAMPLE EXPECTED DATA FRAGMENT: category_tree:de:en_us** + +```yaml +{ + "category_nodes_storage": [ + { + "id_category": 5, + "node_id": 5, + "name": "Computer", + "url": "/en/computer", + "is_active": true, + "template_path": "@CatalogPage/views/simple-cms-block/simple-cms-block.twig", + "order": 100, + "meta_title": "Computer", + "meta_description": "Computer", + "meta_keywords": "Computer", + "children": [ + { + "id_category": 6, + "node_id": 6, + "name": "Notebooks", + "url": "/en/computer/notebooks", + "is_active": true, + "template_path": "@CatalogPage/views/catalog-with-cms-slot/catalog-with-cms-slot.twig", + "order": 100, + "meta_title": "Notebooks", + "meta_description": "Notebooks", + "meta_keywords": "Notebooks" + }, + ] + }, + { + "id_category": 2, + "node_id": 2, + "name": "Cameras & Camcorders", + "url": "/en/cameras-&-camcorders", + "is_active": true, + "template_path": "@CatalogPage/views/catalog/catalog.twig", + "order": 90, + "meta_title": "Cameras & Camcorders", + "meta_description": "Cameras & Camcorders", + "meta_keywords": "Cameras & Camcorders", + "children": [] + } + ], + "_timestamp": 1621934347.540677 +} +``` + +
+ +
+ EXAMPLE EXPECTED DATA FRAGMENT: category_image:de_de:15 + +```yaml +{ + "id_category": 15, + "image_sets": [ + { + "name": "default", + "images": [ + { + "id_category_image": 2, + "external_url_large": "https://images.icecat.biz/img/norm/high/1113777-8051.jpg", + "external_url_small": "https://images.icecat.biz/img/gallery_mediums/img_1113777_medium_1480988786_4473_5647.jpg" + } + ] + } + ], + "_timestamp": 1622025094.247298 +} +``` + +
+ +{% endinfo_block %} + +### 7) Import data + +1. Prepare your data according to your requirements using our demo data: + +**data/import/common/common/category.csv** + +```csv +category_key,parent_category_key,name.de_DE,name.en_US,meta_title.de_DE,meta_title.en_US,meta_description.de_DE,meta_description.en_US,meta_keywords.de_DE,meta_keywords.en_US,is_active,is_in_menu,is_searchable,is_root,is_main,node_order,template_name +cameras-and-camcorder,demoshop,Kameras & Camcorders,Cameras & Camcorders,Kameras & Camcorders,Cameras & Camcorders,Kameras & Camcorders,Cameras & Camcorders,Kameras & Camcorders,Cameras & Camcorders,1,1,1,0,1,90,Catalog (default) +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DESCRIPTION | +|------------------------|----------|-----------|-----------------------|------------------------------------------------------------------------------------------------------------------------------| +| category_key | ✓ | string | cameras-and-camcorder | Sluggable name of the category. | +| parent_category_key | | string | demoshop | Sluggable name of the parent category. | +| name.de_DE | ✓ | string | Kameras & Camcorders | Human-readable name of the category (de). | +| name.en_US | ✓ | string | Cameras & Camcorders | Human-readable name of the category (en). | +| meta_title.de_DE | ✓ | string | Kameras & Camcorders | Human-readable title for category (de). | +| meta_title.en_US | ✓ | string | Cameras & Camcorders | A Human-readable title for category (en). | +| meta_description.de_DE | ✓ | string | Kameras & Camcorders | A Human-readable description for category (de). | +| meta_description.en_US | ✓ | string | Cameras & Camcorders | A Human-readable description for category (en). | +| meta_keywords.de_DE | ✓ | string | Kameras & Camcorders | A Human-readable keywords for category (de). | +| meta_keywords.en_US | ✓ | string | Cameras & Camcorders | A Human-readable keywords for category (en). | +| is_active | | bool | 1 | Defines if the category is active. | +| is_in_menu | | bool | 1 | Defines if the category is displayed in the menu on the Storefront. | +| is_searchable | | bool | 1 | Defines if the category is displayed in the search. If the value is `0`, the category cannot be found in the catalog search. | +| is_root | | bool | 0 | Defines if the category. is a root category: `0` – non-root category, `1` – root category. | +| is_main | | bool | 1 | Defines if the category is main. | +| node_order | | int | 90 | When displayed with other categories, defines their order based on the comparison of this parameter's values. | +| template_name | | string | Catalog (default) | Human-readable name of the category template. | + +**data/import/common/DE/category_store.csv** + +```csv +category_key,included_store_names,excluded_store_names +demoshop,DE, +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DESCRIPTION | +|----------------------|----------|-----------|--------------|------------------------------------------------------| +| category_key | ✓ | string | demoshop | Sluggable name of the category. | +| included_store_names | | string | DE | List of the store names to link to the category. | +| excluded_store_names | | string | "US,AT" | List of the store names to unlink from the category. | + +**data/import/category_template.csv** + +```csv +template_name,template_path +"Sub Categories grid","@CatalogPage/views/sub-categories-grid/sub-categories-grid.twig" +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DESCRIPTION | +|---------------|----------|-----------|--------------------------------------------|-----------------------------------------------------------------| +| template_name | ✓ | string | My category template | A human-readable name of the category template. | +| template_path | ✓ | string | @ModuleName/path/to/category/template.twig | Category template path that is used to display a category page. | + +2. Register the following data import plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------|----------------------------------|---------------|----------------------------------------------------------------| +| CategoryDataImportPlugin | Imports the category data. | | Spryker\Zed\CategoryDataImport\Communication\Plugin | +| CategoryStoreDataImportPlugin | Imports the category store data. | | Spryker\Zed\CategoryDataImport\Communication\Plugin\DataImport | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php +src/Pyz/Zed/Category/CategoryDependencyProvider.php + +```php + + +**src/Pyz/Zed/CategoryGui/CategoryGuiDependencyProvider.php** + +```php + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + 'button-action': TableColumnButtonActionConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + 'button-action': TableColumnButtonActionComponent, + }), + TableColumnButtonActionModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Table Column Button Action interfaces: + +```ts +export type ButtonAttributes = Record; +export type ActionType = RegistryType; + +interface TableColumnButtonAction extends ActionConfig { + type: ActionType; + [k: string]: unknown; +} + +interface TableColumnButtonActionConfig { + /** Bound to the @spryker/button-action inputs */ + text?: string; + action?: TableColumnButtonAction; + actionContext?: unknown; + variant?: ButtonVariant; // 'primary' - by default + shape?: ButtonShape; // 'default' - by default + size?: ButtonSize; // 'md' - by default + attrs?: ButtonAttributes; +} +``` diff --git a/docs/scos/dev/front-end-development/202204.0/marketplace/ui-components-library/actions/actions-confirmation.md b/docs/scos/dev/front-end-development/202204.0/marketplace/ui-components-library/actions/actions-confirmation.md new file mode 100644 index 00000000000..2b6bed93d90 --- /dev/null +++ b/docs/scos/dev/front-end-development/202204.0/marketplace/ui-components-library/actions/actions-confirmation.md @@ -0,0 +1,106 @@ +--- +title: Actions Confirmation +description: This document provides details about the Actions Confirmation service in the Components Library. +template: concept-topic-template +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +Actions Confirmation is an angular Service in the components library that calls another action with a confirmation via the Modal component. + + +## Usage + +Service configuration: + +| ATTRIBUTE | DESCRIPTION | +| - | - | +| `type` | An action type. | +| `action` | Registered action configuration. | +| `modal` | Modal configuration based on the `ConfirmModalStrategyOptions` interface of the Modal component. | + + +Usage example: + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + confirmation: ConfirmationActionHandlerService, + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + confirmation: ConfirmationActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Actions Confirmation interfaces: + +```ts +export interface ConfirmationActionConfig extends ActionConfig { + action: ActionConfig; + modal?: ConfirmModalStrategyOptions; +} + +export interface ConfirmModalStrategyOptions extends ConfirmModalData {} + +export interface ConfirmModalData { + title?: string | TemplateRef>; + description?: string | TemplateRef>; + icon?: string | TemplateRef>; + okText?: string | TemplateRef>; + okType?: string; + okVariant?: ButtonVariant; + okSize?: ButtonSize; + cancelText?: string | TemplateRef>; + cancelType?: string; + cancelVariant?: ButtonVariant; + cancelSize?: ButtonSize; + class?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202212.0/marketplace/table-design/table-column-type-extension/table-column-type-button-action.md b/docs/scos/dev/front-end-development/202212.0/marketplace/table-design/table-column-type-extension/table-column-type-button-action.md new file mode 100644 index 00000000000..4727637f10f --- /dev/null +++ b/docs/scos/dev/front-end-development/202212.0/marketplace/table-design/table-column-type-extension/table-column-type-button-action.md @@ -0,0 +1,106 @@ +--- +title: Table Column Type Button Action +description: This document provides details about the Table Column Type Button Action in the Components Library. +template: concept-topic-template +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +Table Column Button Action is an Angular component in the components library that renders button using the `@spryker/button.action` component. + + +## Usage + +Example of usage in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + 'button-action': TableColumnButtonActionConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + 'button-action': TableColumnButtonActionComponent, + }), + TableColumnButtonActionModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Table Column Button Action interfaces: + +```ts +export type ButtonAttributes = Record; +export type ActionType = RegistryType; + +interface TableColumnButtonAction extends ActionConfig { + type: ActionType; + [k: string]: unknown; +} + +interface TableColumnButtonActionConfig { + /** Bound to the @spryker/button-action inputs */ + text?: string; + action?: TableColumnButtonAction; + actionContext?: unknown; + variant?: ButtonVariant; // 'primary' - by default + shape?: ButtonShape; // 'default' - by default + size?: ButtonSize; // 'md' - by default + attrs?: ButtonAttributes; +} +``` diff --git a/docs/scos/dev/front-end-development/202212.0/marketplace/ui-components-library/actions/actions-confirmation.md b/docs/scos/dev/front-end-development/202212.0/marketplace/ui-components-library/actions/actions-confirmation.md new file mode 100644 index 00000000000..2b6bed93d90 --- /dev/null +++ b/docs/scos/dev/front-end-development/202212.0/marketplace/ui-components-library/actions/actions-confirmation.md @@ -0,0 +1,106 @@ +--- +title: Actions Confirmation +description: This document provides details about the Actions Confirmation service in the Components Library. +template: concept-topic-template +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +Actions Confirmation is an angular Service in the components library that calls another action with a confirmation via the Modal component. + + +## Usage + +Service configuration: + +| ATTRIBUTE | DESCRIPTION | +| - | - | +| `type` | An action type. | +| `action` | Registered action configuration. | +| `modal` | Modal configuration based on the `ConfirmModalStrategyOptions` interface of the Modal component. | + + +Usage example: + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + confirmation: ConfirmationActionHandlerService, + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + confirmation: ConfirmationActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Actions Confirmation interfaces: + +```ts +export interface ConfirmationActionConfig extends ActionConfig { + action: ActionConfig; + modal?: ConfirmModalStrategyOptions; +} + +export interface ConfirmModalStrategyOptions extends ConfirmModalData {} + +export interface ConfirmModalData { + title?: string | TemplateRef>; + description?: string | TemplateRef>; + icon?: string | TemplateRef>; + okText?: string | TemplateRef>; + okType?: string; + okVariant?: ButtonVariant; + okSize?: ButtonSize; + cancelText?: string | TemplateRef>; + cancelType?: string; + cancelVariant?: ButtonVariant; + cancelSize?: ButtonSize; + class?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202307.0/marketplace/table-design/table-column-type-extension/table-column-type-button-action.md b/docs/scos/dev/front-end-development/202307.0/marketplace/table-design/table-column-type-extension/table-column-type-button-action.md new file mode 100644 index 00000000000..4727637f10f --- /dev/null +++ b/docs/scos/dev/front-end-development/202307.0/marketplace/table-design/table-column-type-extension/table-column-type-button-action.md @@ -0,0 +1,106 @@ +--- +title: Table Column Type Button Action +description: This document provides details about the Table Column Type Button Action in the Components Library. +template: concept-topic-template +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +Table Column Button Action is an Angular component in the components library that renders button using the `@spryker/button.action` component. + + +## Usage + +Example of usage in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + 'button-action': TableColumnButtonActionConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + 'button-action': TableColumnButtonActionComponent, + }), + TableColumnButtonActionModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Table Column Button Action interfaces: + +```ts +export type ButtonAttributes = Record; +export type ActionType = RegistryType; + +interface TableColumnButtonAction extends ActionConfig { + type: ActionType; + [k: string]: unknown; +} + +interface TableColumnButtonActionConfig { + /** Bound to the @spryker/button-action inputs */ + text?: string; + action?: TableColumnButtonAction; + actionContext?: unknown; + variant?: ButtonVariant; // 'primary' - by default + shape?: ButtonShape; // 'default' - by default + size?: ButtonSize; // 'md' - by default + attrs?: ButtonAttributes; +} +``` diff --git a/docs/scos/dev/front-end-development/202307.0/marketplace/ui-components-library/actions/actions-confirmation.md b/docs/scos/dev/front-end-development/202307.0/marketplace/ui-components-library/actions/actions-confirmation.md new file mode 100644 index 00000000000..2b6bed93d90 --- /dev/null +++ b/docs/scos/dev/front-end-development/202307.0/marketplace/ui-components-library/actions/actions-confirmation.md @@ -0,0 +1,106 @@ +--- +title: Actions Confirmation +description: This document provides details about the Actions Confirmation service in the Components Library. +template: concept-topic-template +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +Actions Confirmation is an angular Service in the components library that calls another action with a confirmation via the Modal component. + + +## Usage + +Service configuration: + +| ATTRIBUTE | DESCRIPTION | +| - | - | +| `type` | An action type. | +| `action` | Registered action configuration. | +| `modal` | Modal configuration based on the `ConfirmModalStrategyOptions` interface of the Modal component. | + + +Usage example: + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + confirmation: ConfirmationActionHandlerService, + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + confirmation: ConfirmationActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Actions Confirmation interfaces: + +```ts +export interface ConfirmationActionConfig extends ActionConfig { + action: ActionConfig; + modal?: ConfirmModalStrategyOptions; +} + +export interface ConfirmModalStrategyOptions extends ConfirmModalData {} + +export interface ConfirmModalData { + title?: string | TemplateRef>; + description?: string | TemplateRef>; + icon?: string | TemplateRef>; + okText?: string | TemplateRef>; + okType?: string; + okVariant?: ButtonVariant; + okSize?: ButtonSize; + cancelText?: string | TemplateRef>; + cancelType?: string; + cancelVariant?: ButtonVariant; + cancelSize?: ButtonSize; + class?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.md index bd67075d02b..5e406090560 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.md @@ -7,6 +7,8 @@ redirect_from: related: - title: Table Column Type extension link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Button Action + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: Table Column Type Chip link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html - title: Table Column Type Date diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-button-action.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-button-action.md new file mode 100644 index 00000000000..4727637f10f --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-button-action.md @@ -0,0 +1,106 @@ +--- +title: Table Column Type Button Action +description: This document provides details about the Table Column Type Button Action in the Components Library. +template: concept-topic-template +related: + - title: Table Column Type extension + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html + - title: Table Column Type Autocomplete + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Chip + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html + - title: Table Column Type Date + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html + - title: Table Column Type Dynamic + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html + - title: Table Column Type Image + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-image.html + - title: Table Column Type Input + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-input.html + - title: Table Column Type List + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-list.html + - title: Table Column Type Select + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-select.html + - title: Table Column Type Text + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-text.html +--- + +Table Column Button Action is an Angular component in the components library that renders button using the `@spryker/button.action` component. + + +## Usage + +Example of usage in the `@spryker/table` config: + +```html + + +``` + +## Component registration + +Register the component: + +```ts +declare module '@spryker/table' { + interface TableColumnTypeRegistry { + 'button-action': TableColumnButtonActionConfig; + } +} + +@NgModule({ + imports: [ + TableModule.forRoot(), + TableModule.withColumnComponents({ + 'button-action': TableColumnButtonActionComponent, + }), + TableColumnButtonActionModule, + ], +}) +export class RootModule {} +``` + +## Interfaces + +Table Column Button Action interfaces: + +```ts +export type ButtonAttributes = Record; +export type ActionType = RegistryType; + +interface TableColumnButtonAction extends ActionConfig { + type: ActionType; + [k: string]: unknown; +} + +interface TableColumnButtonActionConfig { + /** Bound to the @spryker/button-action inputs */ + text?: string; + action?: TableColumnButtonAction; + actionContext?: unknown; + variant?: ButtonVariant; // 'primary' - by default + shape?: ButtonShape; // 'default' - by default + size?: ButtonSize; // 'md' - by default + attrs?: ButtonAttributes; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-chip.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-chip.md index 4eabab1423b..e513ed56dcf 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-chip.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-chip.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html - title: Table Column Type Autocomplete link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Button Action + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: Table Column Type Date link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-date.html - title: Table Column Type Dynamic diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-date.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-date.md index 53452447669..f7eb171939b 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-date.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-date.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html - title: Table Column Type Autocomplete link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Button Action + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: Table Column Type Chip link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html - title: Table Column Type Dynamic diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.md index 25493afb2a9..579db46754f 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html - title: Table Column Type Autocomplete link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Button Action + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: Table Column Type Chip link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html - title: Table Column Type Date diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-extension.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-extension.md index d312a400c16..5b1522bd23e 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-extension.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-extension.md @@ -7,6 +7,8 @@ redirect_from: related: - title: Table Column Type Autocomplete link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Button Action + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: Table Column Type Chip link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html - title: Table Column Type Date @@ -202,6 +204,7 @@ export enum ColumnTypeOptionsType { UI library comes with a number of standard column types that can be used on any project: - [Autocomplete](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html) - renders `@spryker/input` and `@spryker/autocomplete` components. +- [Button-action](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html) - renders `@spryker/button-action` component. - [Chip](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-chip.html) - renders `@spryker/chip` component. - [Date](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-date.html) - renders a formatted date by `config`. - [Dynamic](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/table-design/table-column-type-extension/table-column-type-dynamic.html) - is a higher-order column that gets `ColumnConfig` from the configured `Datasource` and renders a column with the retrieved `ColumnConfig`. diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-image.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-image.md index a164fe65872..2789f23b4da 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-image.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-image.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html - title: Table Column Type Autocomplete link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Button Action + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: Table Column Type Chip link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html - title: Table Column Type Date diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-input.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-input.md index 1d6b15eb63d..e0472c4388c 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-input.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-input.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html - title: Table Column Type Autocomplete link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Button Action + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: Table Column Type Chip link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html - title: Table Column Type Date diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-list.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-list.md index 185eccc2c29..1de2ba86c54 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-list.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-list.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html - title: Table Column Type Autocomplete link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Button Action + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: Table Column Type Chip link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html - title: Table Column Type Date diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-select.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-select.md index 13921b1aa65..4e2e8c3c372 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-select.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-select.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html - title: Table Column Type Autocomplete link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Button Action + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: Table Column Type Chip link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html - title: Table Column Type Date diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-text.md b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-text.md index a63dee32deb..1302464a654 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-text.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/table-design/table-column-type-extension/table-column-type-text.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-extension.html - title: Table Column Type Autocomplete link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-autocomplete.html + - title: Table Column Type Button Action + link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-button-action.html - title: Table Column Type Chip link: docs/scos/dev/front-end-development/page.version/marketplace/table-design/table-column-type-extension/table-column-type-chip.html - title: Table Column Type Date diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-close-drawer.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-close-drawer.md index b9187321197..2ba6d3dc578 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-close-drawer.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-close-drawer.md @@ -7,6 +7,8 @@ redirect_from: related: - title: Actions link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Confirmation + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-confirmation.html - title: Actions Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html - title: Actions HTTP diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-confirmation.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-confirmation.md new file mode 100644 index 00000000000..2b6bed93d90 --- /dev/null +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-confirmation.md @@ -0,0 +1,106 @@ +--- +title: Actions Confirmation +description: This document provides details about the Actions Confirmation service in the Components Library. +template: concept-topic-template +related: + - title: Actions + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html + - title: Actions Close Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html + - title: Actions HTTP + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html + - title: Actions Notification + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-notification.html + - title: Actions Redirect + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-redirect.html + - title: Actions Refresh Drawer + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-drawer.html + - title: Actions Refresh Parent Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-parent-table.html + - title: Actions Refresh Table + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-refresh-table.html + +--- + +Actions Confirmation is an angular Service in the components library that calls another action with a confirmation via the Modal component. + + +## Usage + +Service configuration: + +| ATTRIBUTE | DESCRIPTION | +| - | - | +| `type` | An action type. | +| `action` | Registered action configuration. | +| `modal` | Modal configuration based on the `ConfirmModalStrategyOptions` interface of the Modal component. | + + +Usage example: + +```html + + +``` + +## Service registration + +Register the service: + +```ts +declare module '@spryker/actions' { + interface ActionsRegistry { + confirmation: ConfirmationActionHandlerService, + } +} + +@NgModule({ + imports: [ + ActionsModule.withActions({ + confirmation: ConfirmationActionHandlerService, + }), + ], +}) +export class RootModule {} +``` + +## Interfaces + +Actions Confirmation interfaces: + +```ts +export interface ConfirmationActionConfig extends ActionConfig { + action: ActionConfig; + modal?: ConfirmModalStrategyOptions; +} + +export interface ConfirmModalStrategyOptions extends ConfirmModalData {} + +export interface ConfirmModalData { + title?: string | TemplateRef>; + description?: string | TemplateRef>; + icon?: string | TemplateRef>; + okText?: string | TemplateRef>; + okType?: string; + okVariant?: ButtonVariant; + okSize?: ButtonSize; + cancelText?: string | TemplateRef>; + cancelType?: string; + cancelVariant?: ButtonVariant; + cancelSize?: ButtonSize; + class?: string; +} +``` diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-drawer.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-drawer.md index 420b15c5798..e359561b2b9 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-drawer.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-drawer.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html - title: Actions Close Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Confirmation + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-confirmation.html - title: Actions HTTP link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-http.html - title: Actions Notification diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-http.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-http.md index f20e9a607cc..4555065ff8c 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-http.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-http.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html - title: Actions Close Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Confirmation + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-confirmation.html - title: Actions Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html - title: Actions Notification diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-notification.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-notification.md index b2911571437..975a96a556d 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-notification.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-notification.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html - title: Actions Close Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Confirmation + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-confirmation.html - title: Actions Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html - title: Actions HTTP diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-redirect.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-redirect.md index f01452a7512..c56a9e2ce9d 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-redirect.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-redirect.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html - title: Actions Close Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Confirmation + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-confirmation.html - title: Actions Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html - title: Actions HTTP diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-drawer.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-drawer.md index 6a35d929a01..0205e23d4bf 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-drawer.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-drawer.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html - title: Actions Close Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Confirmation + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-confirmation.html - title: Actions Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html - title: Actions HTTP diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-parent-table.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-parent-table.md index bd931dcc99c..3ce8793751a 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-parent-table.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-parent-table.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html - title: Actions Close Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Confirmation + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-confirmation.html - title: Actions Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html - title: Actions HTTP diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-table.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-table.md index 9454dd3fd0e..9ee2fbf8f9e 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-table.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/actions-refresh-table.md @@ -9,6 +9,8 @@ related: link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/ui-components-library-actions.html - title: Actions Close Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Confirmation + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-confirmation.html - title: Actions Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html - title: Actions HTTP diff --git a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/ui-components-library-actions.md b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/ui-components-library-actions.md index 990da9bc237..c411b942550 100644 --- a/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/ui-components-library-actions.md +++ b/docs/scos/dev/front-end-development/202311.0/marketplace/ui-components-library/actions/ui-components-library-actions.md @@ -7,6 +7,8 @@ redirect_from: related: - title: Actions Close Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-close-drawer.html + - title: Actions Confirmation + link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-confirmation.html - title: Actions Drawer link: docs/scos/dev/front-end-development/page.version/marketplace/ui-components-library/actions/actions-drawer.html - title: Actions HTTP @@ -117,13 +119,16 @@ export interface ActionHandler ## Action types -There are a few common Actions that are available in UI library as separate packages: +The following common Actions are available in UI library as separate packages: -- [Close-drawer](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-close-drawer.html) - closes the first Drawer in the current context. -- [Drawer](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-drawer.html) - opens component in the Drawer. -- [HTTP](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-http.html) - renders content via html request. -- [Notification](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-notification.html) - renders notification box. -- [Redirect](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-redirect.html) - performs the hard redirect to the URL. -- [Refresh-drawer](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-refresh-drawer.html) - refreshes/rerenders opened Drawer in current context. -- [Refresh-parent-table](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-refresh-parent-table.html) - refreshes data of the parent Table of a Table in current context. -- [Refresh-table](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-refresh-table.html) - refreshes data of the Table in current context. +| ACTION | DESCRIPTION | + +| [Close-drawer](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-close-drawer.html) | Closes the first Drawer in the current context.| +| [Confirmation](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-confirmation.html) | Calls another registered action with a confirmation.| +| [Drawer](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-drawer.html) | Opens a component in the Drawer.| +| [HTTP](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-http.html) | Renders content via an HTML request.| +| [Notification](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-notification.html) | Renders a notification box.| +| [Redirect](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-redirect.html) | Performs a hard redirect to the URL. | +| [Refresh-drawer](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-refresh-drawer.html) | Refreshes or rerenders an opened Drawer in the current context. | +| [Refresh-parent-table](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-refresh-parent-table.html) | Refreshes the data of the parent Table of a Table the in current context. | +| [Refresh-table](/docs/scos/dev/front-end-development/{{page.version}}/marketplace/ui-components-library/actions/actions-refresh-table.html) | Refreshes the data of the Table the in the current context. |