From cc0518f95a9e52aa6bcf6685e9a33467fc060591 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20Su=C3=A1rez=20Ruiz?= Date: Thu, 15 Mar 2018 20:44:44 +0100 Subject: [PATCH] Added Ooui Forms Status Documentation --- Documentation/OouiFormsStatus.md | 428 +++++++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 429 insertions(+), 1 deletion(-) create mode 100644 Documentation/OouiFormsStatus.md diff --git a/Documentation/OouiFormsStatus.md b/Documentation/OouiFormsStatus.md new file mode 100644 index 0000000..fb9c9d7 --- /dev/null +++ b/Documentation/OouiFormsStatus.md @@ -0,0 +1,428 @@ +# Ooui.Forms Status + +### ActivityIndicator + +The [ActivityIndicator](https://developer.xamarin.com/api/type/Xamarin.Forms.ActivityIndicator/) control gives a visual clue to the user that something is happening, without information about its progress. + +Property | Status +------ | ------ +BackgroundColor | Done +IsRunning | Done +Color | Pending + +### ActionSheets + +The UIActionSheet is a common UI element in iOS. The Xamarin.Forms [DisplayActionSheet](https://developer.xamarin.com/guides/xamarin-forms/application-fundamentals/navigation/pop-ups/) method lets you include this control in cross-platforms apps, rendering native alternatives. + +Property | Status +------ | ------ +Title | Pending +Cancel | Pending +Extras | Pending +Destruction | Pending + +### BoxView + +[BoxView](https://developer.xamarin.com/api/type/Xamarin.Forms.BoxView/) is a useful stand-in for images or custom elements when doing initial prototyping. + +Property | Status +------ | ------ +BackgroundColor | Done +Color | Done + +### Button + +A [button](https://developer.xamarin.com/api/type/Xamarin.Forms.Button/) View that reacts to touch events. + +Property | Status +------ | ------ +BackgroundColor | Done +IsEnabled | Done +Command | Done +CommandParameter | Done +ContentLayout | Done +Text | Done +TextColor | Done +Font | Done +FontFamily | Done +FontAttributes | Done +BorderWidth | Done +BorderColor | Done +BorderRadius | Done +Image | Pending +Clicked | Done +Pressed | Done +Released | Done + +### CarouselPage + +The Xamarin.Forms [CarouselPage](https://developer.xamarin.com/guides/xamarin-forms/application-fundamentals/navigation/carousel-page/) is a page that users can swipe from side to side to navigate through pages of content, like a gallery. + +Property | Status +------ | ------ +ItemsSource | Pending +ItemTemplate | Pending +CurrentPage | Pending +Children | Pending +BackgrondImage | Pending +Icon | Pending +IsBusy | Pending +Padding | Pending +Tittle | Pending +ToolbarItems | Pending +CurrentPageChanged | Pending +PagesChanged | Pending +LayoutChanged | Pending +Appearing | Pending +Disappearing | Pending + +### ContentPage + +A [ContentPage](https://developer.xamarin.com/api/type/Xamarin.Forms.ContentPage/) is a Page displaying a single View, often a container like a StackLayout or ScrollView. + +Property | Status +------ | ------ +BackgroundColor | Done +Appearing | Pending +Disappearing | Pending + +DatePicker + +The visual representation of a [DatePicker](https://developer.xamarin.com/api/type/Xamarin.Forms.DatePicker/) is very similar to the one of Entry, except that a special control for picking a date appears in place of a keyboard. + +Property | Status +------ | ------ +BackgroundColor | Done +Format | Done +Date | Done +MinimumDate | Pending +MaximumDate | Pending +TextColor | Pending +DateSelected | Pending + +### Editor + +The [Editor](https://developer.xamarin.com/guides/xamarin-forms/user-interface/text/editor/) control is used to accept multi-line input. + +Property | Status +------ | ------ +BackgroundColor | Done +IsEnabled | Done +Text | Done +FontFamily | Done +FontSize | Done +FontAttributes | Done +TextColor | Done +TextChanged | Done +Completed | Done + +### Entry + +[Entry](https://developer.xamarin.com/api/type/Xamarin.Forms.Entry/) is a single line text entry. It is best used for collecting small discrete pieces of information, like usernames and passwords. + +Property | Status +------ | ------ +BackgroundColor | Done +IsEnabled | Done +Placeholder | Done +PlaceholderColor | Pending +Text | Done +TextColor | Done +FontFamily | Done +FontSize | Done +FontAttributes | Done +TextColor | Done +TextChanged | Done +Completed | Done + +### Frame + +[Frame](https://developer.xamarin.com/api/type/Xamarin.Forms.Frame/) is an element containing a single child, with some framing options. + +Property | Status +------ | ------ +BackgroundColor | Done +OutlineColor | Done +HasShadow | Pending + + +### Image + +[View](https://developer.xamarin.com/api/type/Xamarin.Forms.Image/) that holds an image. + +Property | Status +------ | ------ +BackgroundColor | Done +Source | Done +Aspect | Pending +IsOpaque | Pending +IsLoading | Done + +Supported FileSource, StreamSource and UriSource. + + +### Label + +A [Label](https://developer.xamarin.com/api/type/Xamarin.Forms.Label/) is used to display single-line text elements as well as multi-line blocks of text. + +Property | Status +------ | ------ +BackgroundColor | Done +IsEnabled | Done +FormattedText | Done +HorizontalTextAlignment | Done +LineBreakMode | Pending +Text | Done +TextColor | Done +VerticalTextAlignment | Done +FontAttributes | Done +FontFamily | Done +FontSize | Done +XAlign | Done +YAlign | Done + +### ListView + +An [ItemsView](https://developer.xamarin.com/api/type/Xamarin.Forms.ListView/) that displays a collection of data as a vertical list. + +Property | Status +------ | ------ +IsPullToRefreshEnabled | Pending +IsRefreshing | Pending +ItemsSource | Done +RefreshCommand | Pending +Header | Pending +HeaderTemplate | Pending +Footer | Pending +FooterTemplate | Pending +SelectedItem | Done +HasUnevenRows | Pending +RowHeight | Pending +GroupHeaderTemplate | Done +IsGroupingEnabled | Pending +SeparatorVisibility | Pending +SeparatorColor | Pending +ContextActions | Pending +ScrollTo | Pending +ItemAppearing | Pending +ItemDisappearing | Pending +ItemSelected | Pending +ItemTapped | Done +Refresing | Pending + +### MasterDetailPage + +A [Page](https://developer.xamarin.com/api/type/Xamarin.Forms.MasterDetailPage/) that manages two panes of information: A master page that presents data at a high level, and a detail page that displays low-level details about information in the master. + +Property | Status +------ | ------ +Detail | Pending +IsGestureEnabled | Pending +IsPresented | Pending +Master | Pending +MasterBehavior | Pending +ShouldShowToolBarButton | Pending +IsPresentedChanged | Pending + +### Map + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.Maps.Map/) that shows a map provided by a platform-specific service. + +Property | Status +------ | ------ +Pins | Pending +MapType | Pending +IsShowingUser | Pending +HasScrollEnabled | Pending +HasZoomEnabled | Pending +VisibleRegion | Pending +MoveToRegion | Pending + +### NavigationPage + +A [Page](https://developer.xamarin.com/api/type/Xamarin.Forms.NavigationPage/) that manages the navigation and user-experience of a stack of other pages. + +Property | Status +------ | ------ +Animate | Pending +Add | Pending +Remove | Pending + +### OpenGLView + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.OpenGLView/) that displays OpenGL content. + +Property | Status +------ | ------ +HasRenderLoop | Pending + + +### Picker + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.Picker/) control for picking an element in a list. + +Property | Status +------ | ------ +Title | Pending +SelectedIndex | Pending +ItemsSource | Pending +SelectedItem | Pending +Items | Pending +itemDisplayBinding | Pending +SelectedIndexChanged | Pending + +### Progress + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.ProgressBar/) control that displays progress. + +Property | Status +------ | ------ +BackgroundColor | Pending +Progress | Done +ProgressTo | Pending + +### ScrollView + +An [element](https://developer.xamarin.com/api/type/Xamarin.Forms.ScrollView/) capable of scrolling if its Content requires. + +Property | Status +------ | ------ +BackgroundColor | Pending +Orientation | Pending +ScrollX | Pending +ScrollY | Pending +Content | Pending +ContentSize | Pending +ScrollToAsync | Pending +Scrolled | Pending + +### SearchBar + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.SearchBar/) control that provides a search box. + +Property | Status +------ | ------ +BackgroundColor | Done +SearchCommand | Done +SearchCommandParameter | Done +CancelButtonColor | Pending +Placeholder | Done +FontFamily | Pending +FontSize | Pending +FontAtttributes | Pending +HorizontalTextAlignment | Done +TextColor | Done +PlaceholderColor | Pending +FontFamily | Pending +SearchButtonPressed | Done +TextChanged | Done + +### Slider + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.Slider/) control that inputs a linear value. + +Property | Status +------ | ------ +BackgroundColor | Done +Minimum | Done +Maximum | Done +Value | Done +ValueChanged | Done + +### Stepper + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.Stepper/) control that inputs a discrete value, constrained to a range. + +Property | Status +------ | ------ +BackgroundColor | Pending +Minimum | Pending +Maximum | Pending +Value | Pending +Increment | Pending +ValueChanged | Pending + +### Switch + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.Switch/) control that provides a toggled value. + +Property | Status +------ | ------ +BackgroundColor | Done +IsToggled | Done +Toggled | Done + +### TabbedPage + +[Displays](https://developer.xamarin.com/api/type/Xamarin.Forms.TabbedPage/) an array of tabs across the top of the screen, each of which loads content onto the screen. + +Property | Status +------ | ------ +BarBackgroundColor | Pending +BarTextColor | Pending +ItemsSource | Pending +ItemTemplate | Pending +SelectedItem | Pending +GetIndex | Pending +GetPageByIndex | Pending +SetIndex | Pending +Appearing | Pending +Disappearing | Pending +CurrentPageChanged | Pending +PagesChanged | Pending + +### TableView + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.TableView/) that holds rows of Cell elements. + +Property | Status +------ | ------ +BackgroundColor | Pending +HasUnevenRows | Pending +TableIntent | Pending +RowHeight | Pending +Root | Pending +ContextActions | Pending + +### TimePicker + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.TimePicker/) control that provides time picking. + +Property | Status +------ | ------ +BackgroundColor | Done +Format | Done +TextColor | Done +Time | Done + +### WebView + +A [View](https://developer.xamarin.com/api/type/Xamarin.Forms.WebView/) that presents HTML content. + +Property | Status +------ | ------ +CanGoBack | Pending +CamGoForward | Pending +Source | Done +Eval | Pending +GoBack | Pending +GoForward | Pending +Navigated | Pending +Navigating | Pending + +### VisualElement + +Property | Status +------ | ------ +BackgroundColor | Done +AnchorX | Done +AnchorY | Done +IsEnabled | Done +IsFocused | Done +IsVisible | Done +Opacity | Done +RotationX | Pending +RotationY | Pending +Scale | Done +TranslationX | Done +TranslationY | Done \ No newline at end of file diff --git a/README.md b/README.md index c73bbb7..63469c2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ | ------- | ------- | ----------- | | [![NuGet Package](https://img.shields.io/nuget/v/Ooui.svg)](https://www.nuget.org/packages/Ooui) | [Ooui](https://www.nuget.org/packages/Ooui) | Core library with HTML elements and a server | | [![NuGet Package](https://img.shields.io/nuget/v/Ooui.AspNetCore.svg)](https://www.nuget.org/packages/Ooui.AspNetCore) | [Ooui.AspNetCore](https://www.nuget.org/packages/Ooui.AspNetCore) | Integration with ASP.NET Core | -| [![NuGet Package](https://img.shields.io/nuget/v/Ooui.Forms.svg)](https://www.nuget.org/packages/Ooui.Forms) | [Ooui.Forms](https://www.nuget.org/packages/Ooui.Forms) | Xamarin.Forms backend using Ooui | +| [![NuGet Package](https://img.shields.io/nuget/v/Ooui.Forms.svg)](https://www.nuget.org/packages/Ooui.Forms) | [Ooui.Forms](https://www.nuget.org/packages/Ooui.Forms) | Xamarin.Forms backend using Ooui ([Status](Documentation/OouiFormsStatus.md)) | | [![NuGet Package](https://img.shields.io/nuget/v/Ooui.Wasm.svg)](https://www.nuget.org/packages/Ooui.Wasm) | [Ooui.Wasm](https://www.nuget.org/packages/Ooui.Wasm) | Package your app into a web assembly | Ooui (pronounced *weee!*) is a small cross-platform UI library for .NET that uses web technologies.