README.md
1 Android FloatingActionButtonBasic Sample
2 ===================================
3
4 This sample shows the two sizes of Floating Action Buttons and
5 how to interact with them.
6
7 Introduction
8 ------------
9
10 This sample shows how to implement a [Checkable][1] Floating Action Button.
11
12 Floating action buttons are used for a special type of promoted action.
13 They are distinguished by a circled icon floating above the UI and have
14 special motion behaviors related to morphing, launching, and the transferring anchor point.
15
16 Floating action buttons come in two sizes:
17 the default, which should be used in most cases, and the mini,
18 which should only be used to create visual continuity with other elements on the screen.
19
20 Both sizes of Floating Action Buttons are displayed on screen.
21
22 [1]: https://developer.android.com/reference/android/widget/Checkable.html
23
24 Pre-requisites
25 --------------
26
27 - Android SDK v21
28 - Android Build Tools v21.1.1
29 - Android Support Repository
30
31 Screenshots
32 -------------
33
34 <img src="screenshots/screenshot1.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot2.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot3.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot4.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot5.png" height="400" alt="Screenshot"/>
35
36 Getting Started
37 ---------------
38
39 This sample uses the Gradle build system. To build this project, use the
40 "gradlew build" command or use "Import Project" in Android Studio.
41
42 Support
43 -------
44
45 - Google+ Community: https://plus.google.com/communities/105153134372062985968
46 - Stack Overflow: http://stackoverflow.com/questions/tagged/android
47
48 If you've found an error in this sample, please file an issue:
49 https://github.com/googlesamples/android-FloatingActionButtonBasic
50
51 Patches are encouraged, and may be submitted by forking this project and
52 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
53
54 License
55 -------
56
57 Copyright 2014 The Android Open Source Project, Inc.
58
59 Licensed to the Apache Software Foundation (ASF) under one or more contributor
60 license agreements. See the NOTICE file distributed with this work for
61 additional information regarding copyright ownership. The ASF licenses this
62 file to you under the Apache License, Version 2.0 (the "License"); you may not
63 use this file except in compliance with the License. You may obtain a copy of
64 the License at
65
66 http://www.apache.org/licenses/LICENSE-2.0
67
68 Unless required by applicable law or agreed to in writing, software
69 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
70 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
71 License for the specific language governing permissions and limitations under
72 the License.
73