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.

Sign up for GitHub

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

Jump to bottom

docs: Reference of the slide component needs to be more detailed #458

Closed
pjc0247 opened this issue Feb 23, 2016 · 2 comments
Closed

docs: Reference of the slide component needs to be more detailed #458

pjc0247 opened this issue Feb 23, 2016 · 2 comments
Assignees
@brandyscarney
Labels
v2 waiting on update

Comments

@pjc0247
Copy link

pjc0247 commented Feb 23, 2016

Recently, I had a few problems with your slide components.
I think there are some improvement points in the API Reference & Demo usages.

  • How to specify the raw option values. (I know that there is an option property to specify the raw options. but it would be great to make some demo usages for beginners like me.)
  • How to change index at runtime. (In Swiper.js, they already have an API to swipe manually by the script not an user's input. Is there any wrapping methods in ionic2? I coudn't find anything in your docs.)

Thanks.
@pjc0247 pjc0247 changed the title docs: Reference of the slide components needs to be more detailed docs: Reference of the slide component needs to be more detailed Feb 23, 2016
@perrygovier perrygovier added this to the Before "good" milestone Feb 24, 2016
@perrygovier perrygovier modified the milestones: Sprint #1, Before "good" Mar 3, 2016
@mhartington
Copy link
Contributor

So we currently need to hold off until this is finished

ionic-team/ionic-framework#5508

Based on the ideas from
ionic-team/ionic-framework#5189 (comment)

@mhartington mhartington modified the milestones: Before "good", Sprint #1 Mar 11, 2016
brandyscarney added a commit to ionic-team/ionic-framework that referenced this issue Apr 19, 2016
@brandyscarney
refactor(slides): update slide methods and API docs
4654404 
add to docs including how to use the slides and rename methods.

BREAKING CHANGE:

The Slides component has been refactored. Many methods and events were
renamed.

The following events have been renamed:

- `slideChangeStart` has been renamed `willChange`
- `change` has been renamed `didChange`

The following methods have been renamed:

`next()` has been renamed to `slideNext()`
`prev()` has been renamed to `slidePrev()`
`getIndex()` has been renamed to `getActiveIndex()`
`getNumSlides()` has been renamed to `length()`
`isAtEnd()` has been renamed to `isEnd()`
`isAtBeginning()` has been renamed to `isBeginning()`
`getSliderWidget()` has been renamed to `getSlider()`

The following method was added: `slideTo()`

All methods have been documented in the API docs:
http://ionicframework.com/docs/v2/api/components/slides/Slides/

references #5508, references ionic-team/ionic-site#458
brandyscarney added a commit to ionic-team/ionic-framework that referenced this issue Apr 19, 2016
@brandyscarney
docs(slides): update API docs for slides with usage information
ee4869a 
also updated the test for controller.

references #5508 closes ionic-team/ionic-site#458
@brandyscarney
Copy link
Member

brandyscarney commented Apr 20, 2016 •
edited
Loading

Thanks for the issue @pjc0247! I've updated the Slides docs with more explanation, usage and documentation behind the methods exposed. Please let me know if you have any feedback! The docs can be seen on our staging site until we publish them live: http://ionic-site-staging.herokuapp.com/docs/v2/api/components/slides/Slides

Note: many of the methods listed were renamed and will not be available until beta.5 is released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@brandyscarney brandyscarney

Labels
v2 waiting on update
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@perrygovier @pjc0247 @mhartington @brandyscarney