Skip to content

Commit 6098675

Browse files
author
Stephanie Sharp
committed
Add README
1 parent d18722e commit 6098675

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
#MaterialTextField
2+
3+
A [Material Design](https://www.google.com/design/spec/components/text-fields.html#text-fields-single-line-text-field) inspired UITextField with animated placeholder label and error message.
4+
5+
![MaterialTextField screenshot](https://raw.github.com/stephsharp/MaterialTextField/master/materialtextfield.png)
6+
7+
##Features
8+
9+
- Floating placeholder label
10+
- Animates on focus or on text input
11+
- Supports attributed placeholder text with custom fonts
12+
- Can be turned off to use the text field with the default iOS placeholder
13+
- Text field underline
14+
- Line height expands when editing
15+
- Customize colour for default, editing and error states
16+
- Error message
17+
- Animated error message appears below the text field
18+
- Long error messages wrap onto multiple lines
19+
- IBDesignable view
20+
- Adjust the appearance of your text field in Interface Builder with inspectable properties
21+
22+
##Setup
23+
24+
###CocoaPods
25+
26+
To install via CocoaPods, add to your podfile:
27+
28+
pod 'MaterialTextField', '~> 0.1'
29+
30+
###Carthage
31+
32+
TBC
33+
34+
##Acknowledgements
35+
36+
I found the following libraries to be useful references when creating MaterialTextField:
37+
38+
- [MaterialKit](https://github.com/nghialv/MaterialKit)
39+
- [JVFloatLabeledTextField](https://github.com/jverdi/JVFloatLabeledTextField)
40+
41+
42+
##License
43+
44+
The MIT License (MIT)
45+
46+
Copyright (c) 2015 Stephanie Sharp

0 commit comments

Comments
 (0)