Skip to content

Commit

Permalink
Adding several description.yaml files (#48)
Browse files Browse the repository at this point in the history
* Adding several description.yaml files

* added description.yaml to Lifecycle

* added description.yaml to Gestures/Swipe

* added description.yaml to Camera

* added description.yaml to Controls/ButtonWithImage

* added description.yaml for DropdownMenu

* added description.yaml for EdgeNavigator

* added description.yaml to FileBrowser

* add description.yaml to FilterOnObservableCondition

* added description.yaml to GeoLocation

* Added description.yaml to /RelativeTo

* fix typos

* patch names, simplify text
  • Loading branch information
mortoray authored and kristianhasselknippe committed Mar 27, 2017
1 parent 74b9589 commit 7a78a08
Show file tree
Hide file tree
Showing 24 changed files with 297 additions and 20 deletions.
6 changes: 6 additions & 0 deletions Samples/Animation/CyclePhase/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: Animation using repeating Cycle
desc: A continous animation of dots appearing from the left and moving to the right.
api:
-
class: Fuse.Animations.Cycle
desc: Configures a variety of properties to create a structured visual animation.
12 changes: 12 additions & 0 deletions Samples/Camera/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Taking pictures from JavaScript
desc: This example uses the FuseJS Camera, ImageTools and CameraRoll APIs to acquire and manipulate images from JavaScript.
api:
-
class: Fuse.Reactive.WhileEmpty
desc: Is used to show an image while the user has yet to take a picture.
-
class: Fuse.Reactive.WhileNotEmpty
desc: Is used to display a picture after the user has taken it with the camera.
-
class: Fuse.Camera.Camera
desc: The Camera module is used from JavaScript to take a picture using the default platform camera app.
12 changes: 12 additions & 0 deletions Samples/Controls/ButtonWithImage/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Creating a custom button with an image
desc: This example shows two different ways to create a custom button that has an image and text as properties. Which approach you use depends on what is most convenient in your application.
api:
-
class: Fuse.Resources.FileImageSource
desc: Supplies an Image as a resource to a custom button class.
-
class: Fuse.Resources.ImageSource
desc: Declares a ux:Property for a custom button that accepts an image source.
-
class: Uno.UX.FileSource
desc: Declares a ux:property for a custom button that accepts an image file path.
18 changes: 18 additions & 0 deletions Samples/Controls/Circular/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Circular layout and range control
desc: This example creates a time picker for hours and minutes with a circular layout.
api:
-
class: Fuse.Layouts.CircleLayout
desc: Arranges hour and minute values around a clock face.
-
class: Fuse.Controls.RangeControl2d
desc: Creates a two-ring selection for hour selection on a clock face.
-
class: Fuse.Gestures.CircularRangeBehavior
desc: Creates a selection for hours and minutes on a clock face.
-
class: Fuse.Triggers.InteractionCompleted
desc: Progresses to minute selection after the user has selected an hour.
-
class: Fuse.Triggers.RangeAnimation
desc: Animates the change between selecting from two levels in a two-ring hour selection.
9 changes: 9 additions & 0 deletions Samples/Controls/Scrollbar/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: Scrollbar
desc: Shows a scrolling indicator for a `ScrollView` that is only visible while the user is actively scrolling.
api:
-
class: Fuse.Triggers.ScrollingAnimation
desc: Moves a thumb indicator relative to the scroll position.
-
class: Fuse.Triggers.WhileInteracting
desc: Displays a scroll bar only while the user is scrolling.
4 changes: 2 additions & 2 deletions Samples/Controls/Selection/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Selection API Examples
# Pizza Selection Examples

This example demonstrates the various aspects of the selection API by means of a pseudo-pizza delivery app.

Expand All @@ -21,7 +21,7 @@ The button to go to the next page doesn't appear until an item is selected. This
<WhileString Value="{ReadProperty pizzaSel.Value}" Test="IsNotEmpty">


## Multiple Selection
## Multiple Selection

![Multiple selection](https://github.com/fusetools/fuse-samples/blob/master/Samples/Controls/Selection/gifs/multiple.gif)

Expand Down
25 changes: 25 additions & 0 deletions Samples/Controls/Selection/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Pizza Selection
desc: This example demonstrates the various aspects of the selection API by means of a pseudo-pizza delivery app.
api:
-
class: Fuse.Selection.Selection
desc: Creates a multiple select, radio buttons, and a drop-down.
-
class: Fuse.Selection.Selectable
desc: Used UX and JavaScript specified options for selections.
-
class: Fuse.Selection.Selected
desc: Animates an option when it is selected.
-
class: Fuse.Selection.Deselected
desc: Animates an option when it is deselected.
-
class: Fuse.Selection.ToggleSelection
desc: Modifies the selection of an item when the user taps it.
-
class: Fuse.Selection.WhileSelected
desc: Changes the appearance of an item while it is selected.
-
class: Fuse.Layouts.ColumnLayout
desc: Adapts the layout of selection options based on screen size.

12 changes: 12 additions & 0 deletions Samples/DropdownMenu/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: A custom dropdown menu
desc: This example creates custom dropdown menu.
api:
-
class: Fuse.Triggers.WhileTrue
desc: Is used to toggle the expanded state of the dropdown menu.
-
class: Fuse.Triggers.Actions.Toggle
desc: Is used to toggle the WhileTrue trigger containing the expanded state of the dropdown menu.
-
class: Fuse.Reactive.DataBinding
desc: Used to create an explicit data-binding from the Selected state of the dropdown menu.
6 changes: 6 additions & 0 deletions Samples/EdgeNavigator/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: EdgeNavigator example
desc: A minimal example showing off the EdgeNavigator control.
api:
-
class: Fuse.Controls.EdgeNavigator
desc: Displays an edge menu when swiping from the left edge.
18 changes: 18 additions & 0 deletions Samples/FileBrowser/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: A file browser
desc: This example uses the FileSystem JavaScript API to browser the local file system using the Router and Navigator.
api:
-
class: Fuse.FileSystem.FileSystemModule
desc: Is used to query the file system for information.
-
class: Fuse.Controls.Navigator
desc: Is used to navigate between the various folders of the file system.
-
class: Fuse.Navigation.Router
desc: Is used to manage the navigation history through the file system.
-
class: Fuse.Navigation.EnteringAnimation
desc: Animates the opacity of the directory page background as it enters.
-
class: Fuse.Navigation.ExitingAnimation
desc: Animates the opacity of the directory page background as it exits.
12 changes: 12 additions & 0 deletions Samples/FilterOnObservableCondition/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Filter on Observable condition
desc: This example shows how one can filter a list based on a condition which itself is an Observable event.
api:
-
class: Fuse.Triggers.AddingAnimation
desc: Animated a list item as it is added to the list.
-
class: Fuse.Triggers.RemovingAnimation
desc: Animated a list item as it is removed from the list.
-
class: Fuse.Triggers.LayoutAnimation
desc: Animates the remaining part of the list when an item is removed.
7 changes: 7 additions & 0 deletions Samples/GameOfLife/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: Conway's Game of Life
desc: This project uses an array of JavaScript Observables to produce a grid in the interface.
api:
-
class: Fuse.Controls.Grid
desc: A grid bound to a JavaScript data set.

6 changes: 6 additions & 0 deletions Samples/GeoLocation/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: GPS Basics Fuse Example
desc: This is a really basic app showing 3 different ways to use FuseJS GeoLocation API to get the location of our device.
api:
-
class: Fuse.GeoLocation.GeoLocation
desc: Used to get the users current position.
18 changes: 18 additions & 0 deletions Samples/Gestures/Swipe/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: List items with swipe gestures
desc: This example displays a list of items that each lets the user swipe left or right to reveal actions that can be performed on the item.
api:
-
class: Fuse.Gestures.SwipeGesture
desc: Lets the user swipe in a direction to reveal hidden buttons.
-
class: Fuse.Gestures.WhileSwipeActive
desc: Shows an image overlay while the state of the SwipeGesture is set to active.
-
class: Fuse.Gestures.SwipingAnimation
desc: Moves the list item while swiping so that the hidden buttons are revealed.
-
class: Fuse.Gestures.Swiped
desc: Changes the fill color when the swipe gesture has been activated.
-
class: Fuse.Gestures.ToggleSwipeActive
desc: Toggles the active state of the swipe back to false when a button is clicked.
26 changes: 8 additions & 18 deletions Samples/ImageViewer/MainView.ux
Original file line number Diff line number Diff line change
Expand Up @@ -52,33 +52,23 @@
</WhileTrue>

<ZoomGesture Target="TheTransform" Minimum="1" Maximum="3" ux:Name="TheZoom"/>
<Attractor Target="TheTransform.ZoomFactor" ux:Name="TheZoomer" TimeMultiplier="2"/>
<!--
What has happend to SimulationType?
<Attractor Target="TheTransform.ZoomFactor" ux:Name="TheZoomer"
SimulationType="ElasticForceNormalized" TimeMultiplier="2"/>-->
<Attractor Target="TheTransform.ZoomFactor" ux:Name="TheZoomer" TimeMultiplier="2"
Type="Elastic" Unit="Normalized"/>

<RotateGesture Target="TheTransform" ux:Name="TheRotate" StepDegrees="30"/>
<Attractor Target="TheTransform.Rotation" ux:Name="TheRotater" TimeMultiplier="0.5"/>
<!--
What has happend to SimulationType?
<Attractor Target="TheTransform.Rotation" ux:Name="TheRotater"
SimulationType="ElasticForceAngular" TimeMultiplier="0.5"/>-->
<Attractor Target="TheTransform.Rotation" ux:Name="TheRotater" TimeMultiplier="0.5"
Type="Elastic" Unit="Radians"/>

<PanGesture Target="TheTransform" Constraint="TheViewerImage" ux:Name="ThePan"/>
<Attractor Target="TheTransform.Translation" ux:Name="ThePanner" />
<!--
What has happend to SimulationType?
<Attractor Target="TheTransform.Translation" ux:Name="ThePanner"
SimulationType="ElasticForcePoints"/>-->
<Attractor Target="TheTransform.Translation" ux:Name="ThePanner"
Type="Elastic" Unit="Points"/>

<!-- the user might start interacting while the attractors are still running, stop that -->
<WhileInteracting>
<!-- TODO: https://github.com/fusetools/fuselibs/issues/1344 -->
<!-- Fix will be released soon -->
<!--<Change Target="TheZoomer.IsEnabled" Value="false"/>
<Change Target="TheZoomer.IsEnabled" Value="false"/>
<Change Target="TheRotater.IsEnabled" Value="false"/>
<Change Target="ThePanner.IsEnabled" Value="false"/>-->
<Change Target="ThePanner.IsEnabled" Value="false"/>
</WhileInteracting>

<!-- A wrapping panel to ensure the InteractiveTransform and layout transforms don't
Expand Down
32 changes: 32 additions & 0 deletions Samples/ImageViewer/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Pan, Zoom, and Rotate gestures
desc: This demo creates a simple image viewer that uses `ZoomGesture`, `RotateGesture` and `PanGesture`.
last-reviewed: 2017-02-20
api:
-
class: Fuse.Elements.InteractiveTransform
desc: Coordinates the transform values for several gestures on an image viewer.
-
class: Fuse.Animations.Attractor
desc: Provides smooth animation as the user manipulates the image.
-
class: Fuse.Triggers.Actions.CancelInteractions
desc: Dismisses user gestures when the image view is closed.
-
class: Fuse.Triggers.Timeline
desc: Used to create a gallery to full-screen animation of an image.
-
class: Fuse.Triggers.Actions.PulseBackward
desc: Used to transition between a dynamic source and fixed target state.
-
class: Fuse.Triggers.WhileWindowPortrait
desc: Adjusts the gallery layout based on device orientation.
-
class: Fuse.Gestures.ZoomGesture
desc: Zooms an image in an image viewer. Provides a shrink to dismiss feature.
-
class: Fuse.Gestures.PanGesture
desc: Pans an image, constrained to it's visual extents, in an image viewer.
-
class: Fuse.Gestures.RotateGesture
desc: Rotates an image, in fixed increments, in an image viewer.

6 changes: 6 additions & 0 deletions Samples/Lifecycle/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: Lifecycle
desc: This example uses the lifecycle API to change the background color when the app exits the interactive state.
api:
-
class: FuseJS.Lifecycle
desc: Uses the lifecycle API to change the apps background color.
15 changes: 15 additions & 0 deletions Samples/RelativeTo/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Using the RelativeTo and RelativeNode properties
desc: This sample shows the use of the RelativeTo property for the Move animator.
api:
-
class: Fuse.Animations.Move
desc: Used in various places to illustrate the use of the RelativeTo property.
-
class: Fuse.Gestures.WhilePressed
desc: Used to trigger a set of Move animators.
-
class: Fuse.Triggers.LayoutAnimation
desc: Used to move a rectangle in response to it changing position.
-
class: Fuse.Triggers.WhileKeyboardVisible
desc: Used to move the content upwards while the keyboard is visible on screen.
10 changes: 10 additions & 0 deletions Samples/UIStructure/ContextMenu/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Context sensitive status indicators
desc: This examples shows how to add context-sensitive elements to a title bar and status bar.
api:
-
class: Fuse.AlternateRoot
desc: Used to place page indicators in a global status bar.
-
class: Fuse.Navigation.WhileActive
desc: Modifies the state of a status bar while a page is active.

10 changes: 10 additions & 0 deletions Samples/UIStructure/Modal/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Modal confirmation screen
desc: This example shows how to create a modal confirmation screen.
api:
-
class: Fuse.AlternateRoot
desc: Places a panel far up in the UI tree to make it the top-most one.
-
class: Fuse.Resources.ResourceObject
desc: Assigns a node to a resource for use later in an `AlternateRoot`.

18 changes: 18 additions & 0 deletions Samples/UIStructure/Navigation/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Navigator Demo App
desc: This example demonstrates how to combine several pages and components into a single application. It simulates a login/logout process.
api:
-
class: Fuse.Controls.Navigator
desc: Used to structure the navigation between several top-level pages.
-
class: Fuse.Controls.PageControl
desc: Used for section navigation between several related pages.
-
class: Fuse.Navigation.Router
desc: Coordinates a multi-level navigation with a `Navigator` and `PageControl`
-
class: Fuse.Navigation.WhileCanGoBack
desc: Toggles between a back button and menu icon in the title bar.
-
class: Fuse.Controls.EdgeNavigator
desc: Provides a left menu to access various app pages.
9 changes: 9 additions & 0 deletions Samples/UIStructure/PageTabs/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: Simple navigation tab bar
desc: This example shows how to create a navigation tab bar.
api:
-
class: Fuse.Controls.PageIndicator
desc: Creates a tab for each Page, with a page specific color, and allows navigation to it.
-
class: Fuse.Navigation.PageResourceBinding
desc: Binds to page specific resources in the tab bar.
13 changes: 13 additions & 0 deletions Samples/UIStructure/Transition/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Transition Example
desc: This example shows a variety of page transitions during navigation.
api:
-
class: Fuse.Triggers.Transition
desc: Performs a variety of page-to-page transitions, varying the animation based on page name, state and transition type.
-
class: Fuse.Elements.Viewport
desc: Uses a 3d rotation for a page transition effect.
-
class: Fuse.Controls.Navigator
desc: Has several pages with varying animations during transition.

13 changes: 13 additions & 0 deletions Samples/UserEvents/description.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: A component with custom events
desc: This example creates a number pad entry component showing how to define and raise user events.
api:
-
class: Fuse.UserEvent
desc: Creates custom events to for a reusable number pad component.
-
class: Fuse.Triggers.OnUserEvent
desc: Responds to custom events from a reusable number pad component.
-
class: Fuse.Reactive.Match
desc: Provides different visuals for an array of number page buttons.

0 comments on commit 7a78a08

Please sign in to comment.