ngu-carousel icon indicating copy to clipboard operation
ngu-carousel copied to clipboard

A readable example

Open noncom opened this issue 6 years ago • 4 comments

Looking into the usage example hits you with a barely formatted wall of text for the carousel template, which is very hard to read, especially when you at first jump between it and the component JS code a lot to see what goes where.

Could you please extract the template into a separate code block and apply formatting and language highlight to it?

noncom avatar Feb 15 '19 06:02 noncom

Hi @noncom ,

Please check this demo for the usage of this carousel

sheikalthaf avatar Mar 04 '19 09:03 sheikalthaf

@sheikalthaf Thanks, that's much better, but still hard to grasp for a beginner, the best would just be the config object, followed by the array of images, and the template binding.

Just those core concepts would be perfect, adding change detection and everything else can come in as an advanced part of documentation

tayambamwanza avatar Aug 28 '19 19:08 tayambamwanza

I think an example with only the simple example as well, leave out routing etc, just an isolated simple carousel.

Thank you for all the hard work, I can't even begin to imagine how much work you've put in to this, just to help others, I'm deeply grateful.

tayambamwanza avatar Aug 28 '19 19:08 tayambamwanza

Something as simple as this would be very welcoming

https://stackblitz.com/edit/ngu-carousel-demo-n3rfvf

Then later in the docs you can add more complicated examples

tayambamwanza avatar Aug 28 '19 19:08 tayambamwanza