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