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