Sidekick Library in Edge Delivery Services

Happy to find you here. Welcome to another learning.

What is Sidekick Library?

In AEM Edge Delivery Service (EDS), the Sidekick Library is a set of utilities, tools, or pre-defined functions provided to enhance and simplify the development, management, and customization of edge delivery configurations. The Sidekick Library acts as a support framework, enabling developers to work more efficiently with EDS by offering reusable components, patterns, and APIs tailored for edge delivery use cases.

To create a sidekick library we need to do the setup in two places first is in github code/config in git repo and second is file/content setup in content repository

Steps to create sidekick library

• So the first setp is we ned to create a file called library.html under the tools/sidekick folder in our github repo.


• Inside the library.html file we need to add the html code provided by adobe you can get that code in the below link.

  https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/edge-delivery/resources/sidekick/sidekick-library#sidekick-plugin-setup

  Code looks like as shown in the below image



• Next is we need to create the action button in our sidekick so we will be adding the below json in config.json file under tools/sidekick folder. In the below json in URL we will be providing the path of library.html file.



• Next is we need to create a folder hierarchy as tools/sidekick in the root folder of project in google drive or sharepoint inside that we need to create excel file with the name library



• Inside same hierarchy we will be creating a folder called blocks in which we will be keeping all the blocks that we needed in the sidekick library.



• Inside the blocks folder we will be creating the documents for each blocks in this case i will only take the example of cards block.



• In this cards document we will be adding the cards block.



• Next is we will be adding the path each block document(in his case it is cards) in the library excel that we have created.In this excel there will two columns one is name and other is path. "name" column will have the name of the block that needs to be displayed and "path" will contain the path of block document



• Now if you click on the sidekick-library button in the sidekick you will see that new pallet has been opened.



you can see that you got the option of cards under that you can see whatever card I have added it is showing up on the right hand side and there is option of copy . You can copy that and paste in any of the document.

You can also create the variation of the blocks and that too can be visible in the sidekick library, So to create the variations you need to follow the below steps.

1. First thing is you need to seperate the two variations with the seperator which is a horizontal line or a 3 times "-"(hypen)



2. After that you need to add the table with the heading library metadata in each section in that we can add name and description so that both variation should have different names and easy to choose



3. Now you can see in the sidekick library pallet two variations have been added you can choose anyone from both the variations.



Thanks for reading 😄