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

docs: add section about plugins options and improve examples in Motion UI docs #11435

Merged
merged 2 commits into from
Aug 9, 2018

Conversation

ncoden
Copy link
Contributor

@ncoden ncoden commented Aug 5, 2018

Description

The current documentation about Motion UI is not clear enough about how to use the animation classes with the Foundation plugins that support it. A simple example is given for Toggler, and people may think that others components like Reveal can be used the same way (it does not, see to foundation/motion-ui#123).

This pull request add a section about the usage of Motion UI in the Foundation components with a list of the supported components and their options related to Motion UI. It also use a simpler example in the header section.

Changes

  • Move Motion UI Toggler example to its own section
  • Add a simpler example in Motion UI docs header

Screenshots (if appropriate):

screen shot 2018-08-06 at 00 05 43

screen shot 2018-08-06 at 00 05 52

Types of changes

  • Documentation
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing
    functionality to change)

Checklist (all required):

  • I have read and follow the CONTRIBUTING document.
  • There are no other pull request similar to this one.
  • The pull request title is descriptive.
  • The template is fully and correctly filled.
  • The pull request targets the right branch (develop or develop-v...).
  • My commits are correctly titled and contain all relevant information.
  • My code follows the code style of this project.
  • I have updated the documentation accordingly to my changes (if relevant).
  • I have added tests to cover my changes (if relevant).
  • All new and existing tests passed.

@ncoden ncoden force-pushed the docs/motion-ui-components branch from 1b9e266 to bd4bf11 Compare August 5, 2018 22:08
@ncoden ncoden merged commit ce9c886 into foundation:develop Aug 9, 2018
Copy link
Contributor

@DanielRuf DanielRuf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better =)

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

Successfully merging this pull request may close these issues.

2 participants