Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tobihagemann/THLabel

UILabel subclass, which additionally allows shadow blur, inner shadow, stroke text and fill gradient.
https://github.com/tobihagemann/THLabel

gradient objective-c shadow stroke uilabel

Last synced: 6 days ago
JSON representation

UILabel subclass, which additionally allows shadow blur, inner shadow, stroke text and fill gradient.

Host: GitHub
URL: https://github.com/tobihagemann/THLabel
Owner: tobihagemann
License: other
Created: 2012-12-22T10:58:50.000Z (almost 12 years ago)
Default Branch: main
Last Pushed: 2022-09-30T17:53:31.000Z (about 2 years ago)
Last Synced: 2024-12-04T02:50:10.954Z (8 days ago)
Topics: gradient, objective-c, shadow, stroke, uilabel
Language: Objective-C
Homepage: https://tobiha.de
Size: 398 KB
Stars: 669
Watchers: 31
Forks: 110
Open Issues: 10
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

awesome-ios - THLabel - UILabel subclass, which additionally allows shadow blur, inner shadow, stroke text and fill gradient. (UI / Label)
awesome-ios-star - THLabel - UILabel subclass, which additionally allows shadow blur, inner shadow, stroke text and fill gradient. (UI / Label)

README

# THLabel

[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/THLabel.svg)](https://img.shields.io/cocoapods/v/THLabel.svg)
[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![Platform](https://img.shields.io/cocoapods/p/THLabel.svg?style=flat)](http://cocoadocs.org/docsets/THLabel)
[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/tobihagemann)

THLabel is a subclass of UILabel, which additionally allows shadow blur, inner shadow, stroke text and fill gradient.

![THLabel screenshot](https://raw.githubusercontent.com/tobihagemann/THLabel/master/screenshot.png "THLabel screenshot")

## Requirements

* iOS 4.0 or higher (below iOS 7.0 is untested though)
* ARC enabled

## Installation

The easiest way to use THLabel in your app is via [CocoaPods](http://cocoapods.org/ "CocoaPods").

1. Add the following line in the project's Podfile file: `pod 'THLabel', '~> 1.4.0'`
2. Run the command `pod install` from the Podfile folder directory.

### Manual Installation

1. Add `CoreText.framework` to your *Link Binary with Libraries* list.
2. Drag these files into your project: `THLabel.h`, `THLabel.m`

## IBDesignable / IBInspectable

There is an `ibdesignable` branch, if you're interested in this feature. It has been removed from the `master` branch, because IBDesignable and IBInspectable cause problems with CocoaPods, if you're not using `use_frameworks!` in your Podfile.

## Usage

You can create THLabels programmatically, or create them in Interface Builder by dragging an ordinary UILabel into your view and setting its *Custom Class* to THLabel. With Xcode 6 you can set most of the properties within Interface Builder, which will preview your changes immediately.

## Properties

### Spacing

```objective-c
@property CGFloat letterSpacing;
@property CGFloat lineSpacing;
```

You can modify letter spacing of the text (also known as kerning) by changing the `letterSpacing` property. The default value is `0.0`. A positive value will separate the characters, whereas a negative value will make them closer.

Modify line spacing of the text (also known as leading) by changing the `lineSpacing` property. The default value is `0.0`. Only positive values will have an effect.

### Shadow Blur

```objective-c
@property CGFloat shadowBlur;
```

Additionally to UILabel's `shadowColor` and `shadowOffset`, you can set a shadow blur to soften the shadow.

### Inner Shadow

```objective-c
@property CGFloat innerShadowBlur;
@property CGSize innerShadowOffset;
@property UIColor *innerShadowColor;
```

The inner shadow has similar properties as UILabel's shadow, once again additionally with a shadow blur. If an inner shadow and a stroke are overlapping, it will appear beneath the stroke.

### Stroke Text

```objective-c
@property CGFloat strokeSize;
@property UIColor *strokeColor;
@property THLabelStrokePosition strokePosition;
```

You can set an outer, centered or inner stroke by setting the `strokePosition` property. Default value is `THLabelStrokePositionOutside`. Other options are `THLabelStrokePositionCenter` and `THLabelStrokePositionInside`.

### Fill Gradient

```objective-c
@property UIColor *gradientStartColor;
@property UIColor *gradientEndColor;
@property NSArray *gradientColors;
@property CGPoint gradientStartPoint;
@property CGPoint gradientEndPoint;
```

The gradient can consist of multiple colors, which have to be saved as UIColor objects in the `gradientColors` array. For more convenience, `gradientStartColor` and `gradientEndColor` will fill up the array accordingly.

The starting and ending points of the gradient are in the range 0 to 1, where (0, 0) is the top-left and (1, 1) the bottom-right of the text. The default value for `gradientStartPoint` is (0.5, 0.2) and for `gradientEndPoint` it is (0.5, 0.8).

### Fade Truncating

```objective-c
@property THLabelFadeTruncatingMode fadeTruncatingMode;
```

You can fade in/out your label by setting the `fadeTruncatingMode` property. Default value is `THLabelFadeTruncatingModeNone`. The options are `THLabelFadeTruncatingModeTail`, `THLabelFadeTruncatingModeHead` and `THLabelFadeTruncatingModeHeadAndTail`.

### Text Insets / Padding

```objective-c
@property UIEdgeInsets textInsets;
@property BOOL automaticallyAdjustTextInsets;
```

Effects like stroke and shadow can't be drawn outside of the bounds of the label view. You may need to set text insets to move a bit away from the edge so that the effects don't get clipped. This will be automatically done if you set `automaticallyAdjustTextInsets` to `YES`, which is also the default value.

## Notes

THLabel respects (unlike UILabel) the `contentMode` property, which is used for vertical alignment. The `textAlignment` still has the higher priority, when it comes to horizontal alignment.

However THLabel doesn't respect the `numberOfLines` property, because Core Text doesn't support it natively. If you would like to have multiple lines, set `lineBreakMode` to `NSLineBreakByWordWrapping`.

THLabels are slower to draw than UILabels, so be aware of that.

## Credits

Original source and inspiration from:

- FXLabel by Nick Lockwood, https://github.com/nicklockwood/FXLabel
- KSLabel by Kai Schweiger, https://github.com/vigorouscoding/KSLabel
- GTMFadeTruncatingLabel by Google, https://github.com/google/google-toolbox-for-mac/tree/master/iPhone

Big thanks to Jason Miller for showing me sample code of his implementation using Core Text! It inspired me to dig deeper and move away from drawing with NSAttributedString on iOS 7, which caused a lot of problems.

## License

Distributed under the permissive zlib license. See the LICENSE file for more info.

## Contact

Tobias Hagemann

- https://tobiha.de/
- [email protected]
- https://twitter.com/tobihagemann