Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add example on how to build a new component library that includes components from awc #99

Open
larserikfinholt opened this issue Jun 20, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@larserikfinholt
Copy link

Feature Request

Add an example project on how to build a library that configures the adaptive web components according to a given design. This library should aslo have some custom components (in addition to the one from awc) - and it should have a storybook that shows stories of both awc components and the custom one - all with the same prefix

Expected Behavior

Users could start the storybook, and see both the awc components (prefixed with e.g my) and a sample my-counter component. Users could build the library, and instructions on how to use the library should be provided. The final sample should demonstrate how to use the library in a simple html file with both my-button and my-counter , and maybe a call to configureMyLibrary()

Current Behavior

No example provided, difficult to figure out how this should actually be done

Possible Solution

A simple example would that users could use a starting point

Context

An average developer like me find it really difficult to start in the right direction, having a good starting point, set up for sucess makes it easier to commit to building DS

Examples

Not found anything yet

@KingOfTac KingOfTac added the documentation Improvements or additions to documentation label Jun 21, 2023
@KingOfTac
Copy link
Member

@larserikfinholt Thank you for filing an issue. More comprehensive docs are something that we are planning on real soon, so stay tuned.

In the meantime, have you checked out the examples folder to see if it has what you need? https://github.com/Adaptive-Web-Community/Adaptive-Web-Components/tree/main/examples

Feel free to also join the community discord if you have more questions. We'll be happy to answer any questions. https://discord.gg/KPmKKag6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants