aem-core-components-contributions-react-core

AEM - React Wrapper components - for the OOTB AEM Core Components

Usage no npm install needed!

<script type="module">
  import aemCoreComponentsContributionsReactCore from 'https://cdn.skypack.dev/aem-core-components-contributions-react-core';
</script>

README

CircleCI codecov

AEM WCM Components - Community Contributions - React core proposal - Beta

This is a branch of the AEM WCM Components - Community Contributions maintained by Niek Raaijmakers for now. It serves as proposal to introduce react wrappers, that are compatible to be used with web components or the spa editor.

Introduction Video and Demo

Currently supported / exported components:

Page Authoring

  • Button (V1)
  • Text (V2)
  • Teaser (V1)
  • Title (V2)
  • List (V2)
  • Download (V1)
  • List (V2)
  • Separator (V1)

Layout

  • Navigation (V1)
  • Language Navigation (V1)
  • BreadCrumb (V2)

Abstraction

  • AbstractCoreComponent
  • CoreComponentModel (interface)
  • CoreComponentState (interface)

Form

As of now I have no plans to provide support for form components. Feel free to assist with PR's.

Container

Container components won't be provided here as of now, but framework specific support libraries (react-core-spa).

how does this help me??

Please check the github source folder ( react maven sub module ) on how this all works together. In specific, check the example projects (spa / web component) to see exactly how you import / use this library. You leverage these classes in conjunction with web components / spa editor on top of the core components.

If you need nothing else, you just need to provide styling and you are done. If you need to extend the classes, please check the typescript definitions / source code, you can overload methods at will, they are all overrideable.

why such shitty docs??

Well, I am not an engineer, I am a consultant, and work for the customer always comes first. I don't have time to provide extensive documentation at this point, although I would love to. Perhaps in the future, but no promises! Feel free to improve the documentation by providing PR's.

Legal disclaimer

This project is licensed under the Apache V2 License. See LICENSE for more information. As this project is a proposal and maintained by me (at time of development) as Adobe employee, it's copyrights belong to Adobe Systems.

However this project in no way officially provided or supported by Adobe Systems, and Adobe Systems will take no responsibility for financial, indirect or any other sorts of damages incurred by the usage of this software. Use at your own risk.