README_pt-br.md

🌎 Traduções: 🇬🇧 . 🇨🇳 . 🇧🇷 . 🇰🇷 . 🇫🇷

Hoje, quase todos os apps têm processos assíncronos, como requisições de API, processos longos, etc. E enquanto os processos estão ocorrendo, normalmente os desenvolvedores usam uma view que mostra os usuarios que algo está ocorrendo.

SkeletonView foi criado para essa necessidade, um jeito elegante de mostrar aos usuários que algo está acontecendo e já prepará-los para qual conteúdo será carregado.

Aproveite! 🙂

• 🌟 Features
  • 📋 Versões do SDK e OS suportados
  • 🔮 Exemplo
• 📲 Instalação
  • Usando CocoaPods
  • Usando Carthage
• 🐒 Como usar
  • 🌿 Coleções - UITableView - UICollectionView
  • 📰 Texto de várias linhas
    • 🎛 Customização
  • 🎨 Cores customizadas - Imagem capturada do site https://flatuicolors.com
  • 🦋 Aparência
  • 🤓 Animações customizadas
  • 👨‍👧‍👦 Hierarquia
  • 📚 Documentação
• 📬 Próximos passos
• ❤️ Contribuindo - Projeto gerado com SwiftPlate
• 📢 Menções
• 👨🏻‍💻 Autor
• 👮🏻 Licença

🌟 Features

• Fácil de usar
• Todas as UIViews são skeletonables
• Completamente customizável
• Universal (iPhone & iPad)
• Interface Builder friendly
• Sintaxe simples em Swift
• Código leve e legível

📋 Versões do SDK e OS suportados

• iOS 9.0+
• tvOS 9.0+
• Swift 4.2

🔮 Exemplo

Para rodar o projeto de exemplo, clone o repositório e use o target SkeletonViewExample.

📲 Instalação

Usando CocoaPods

Edite seu Podfile e especifíque a dependência:

pod "SkeletonView"

Usando Carthage

Edite seu Cartfile e especifíque a dependência:

github "Juanpe/SkeletonView"

🐒 Como usar

Apenas 3 passos necessários para usar SkeletonView:

1. Importe SkeletonView no lugar desejado.

import SkeletonView

2. Agora, especifíque quais views serão skeletonables. Você consegue fazer isso de duas formas:

Usando código:

avatarImageView.isSkeletonable = true

Usando IB/Storyboards:

3. Uma vez que você setou as views, você pode mostrar o skeleton. Para fazê-lo, você tem 4 escolhas:

(1) view.showSkeleton()                 // Solid
(2) view.showGradientSkeleton()         // Gradient
(3) view.showAnimatedSkeleton()         // Solid animated
(4) view.showAnimatedGradientSkeleton() // Gradient animated

Pré-visualização

Solid	Gradient	Solid Animated	Gradient Animated

IMPORTANTE!

SkeletonView é recursivo, então se você quer mostrar o esqueleto em todas as views skeletonables, você só precisa chamar o método na main container view. Por exemplo, com UIViewControllers

🌿 Coleções

SkeletonView é compatível com UITableView e UICollectionView.

UITableView

Se você quer mostrar o skeleton em uma UITableView, você precisa conformar com o protocolo SkeletonTableViewDataSource.

public protocol SkeletonTableViewDataSource: UITableViewDataSource {
    func numSections(in collectionSkeletonView: UITableView) -> Int
    func collectionSkeletonView(_ skeletonView: UITableView, numberOfRowsInSection section: Int) -> Int
    func collectionSkeletonView(_ skeletonView: UITableView, cellIdentifierForRowAt indexPath: IndexPath) -> ReusableCellIdentifier
}

Como você pode ver, esse protocolo herda de UITableViewDataSource, então você pode substituir esse protocolo com o protocolo do skeleton.

Esse protocolo tem uma implementação padrão:

func numSections(in collectionSkeletonView: UITableView) -> Int
// Default: 1

func collectionSkeletonView(_ skeletonView: UITableView, numberOfRowsInSection section: Int) -> Int
// Default:
// It calculates how many cells need to populate whole tableview

Esse é o único método que você precisa implementar para informar o skeleton sobre o cell identifier. Esse método não possui uma implementação padrão:

func collectionSkeletonView(_ skeletonView: UITableView, cellIdentifierForRowAt indexPath: IndexPath) -> ReusableCellIdentifier

Exemplo

func collectionSkeletonView(_ skeletonView: UITableView, cellIdentifierForRowAt indexPath: IndexPath) -> ReusableCellIdentifier {
   return "CellIdentifier"
}

IMPORTANTE! Se você está usando resizable cells (tableView.rowHeight = UITableViewAutomaticDimension ), é obrigatório definir a estimatedRowHeight.

UICollectionView

Para UICollectionView, você precisa conformar com o protocolo SkeletonCollectionViewDataSource.

public protocol SkeletonCollectionViewDataSource: UICollectionViewDataSource {
    func numSections(in collectionSkeletonView: UICollectionView) -> Int
    func collectionSkeletonView(_ skeletonView: UICollectionView, numberOfItemsInSection section: Int) -> Int
    func collectionSkeletonView(_ skeletonView: UICollectionView, cellIdentifierForItemAt indexPath: IndexPath) -> ReusableCellIdentifier
}

O resto do processo é o mesmo da UITableView

📰 Texto de várias linhas

Quando você usar elementos com texto, SkeletonView desenha linhas para simular o texto. Além disso, você pode decidir quantas linhas você quer. Se numberOfLines está setado para zero (0), haverá um cálculo para saber quantas linhas são necessárias para preencher o skeleton inteiro e será desenhado. Caso contrário, se você setar para um (1) ou qualquer outro número maior que zero, só serão desenhadas aquele número de linhas.

🎛 Customização

Você pode setar algumas propriedades para elementos de várias linhas.

Property	Values	Default	Preview
Filling percent of the last line.	0...100	70%
Corner radius of lines. (NEW)	0...10	0

Para modificar a percentagem ou o raio usando código, especifique as propriedades:

descriptionTextView.lastLineFillPercent = 50
descriptionTextView.linesCornerRadius = 5

Ou, se você preferir use IB/Storyboard:

🎨 Cores customizadas

Você pode decidir que cor o skeleton esta pintado. Você só precisa parametrizar a cor e o gradiente que deseja.

Usando cores sólidas

view.showSkeleton(usingColor: UIColor.gray) // Solid
// or
view.showSkeleton(usingColor: UIColor(red: 25.0, green: 30.0, blue: 255.0, alpha: 1.0))

Usando gradientes

let gradient = SkeletonGradient(baseColor: UIColor.midnightBlue)
view.showGradientSkeleton(usingGradient: gradient) // Gradient

Além do mais, SkeletonView tem 20 cores flat 🤙🏼

UIColor.turquoise, UIColor.greenSea, UIColor.sunFlower, UIColor.flatOrange ...

Imagem capturada do site https://flatuicolors.com

🦋 Aparência

NOVIDADE Os skeletons tem uma aparência padrão. Então, quando você não especifíca a cor, gradiente ou propriedades de várias linhas, SkeletonView usa os valores padrões.

Valores padrões:

• tintColor: UIColor
  • default: .clouds
• gradient: SkeletonGradient
  • default: SkeletonGradient(baseColor: .clouds)
• multilineHeight: CGFloat
  • default: 15
• multilineSpacing: CGFloat
  • default: 10
• multilineLastLineFillPercent: Int
  • default: 70
• multilineCornerRadius: Int
  • default: 0

Para obter esses valores padrões você pode usar SkeletonAppearance.default. Usando essa propriedade você pode declarar os valores também:

SkeletonAppearance.default.multilineHeight = 20
SkeletonAppearance.default.tintColor = .green

🤓 Animações customizadas

SkeletonView tem duas animações pré-definidas, pulse para skeletons solidos e sliding para gradientes.

Além disso, se você quiser fazer suas próprias animações no skeleton, é muito fácil.

Skeleton disponibiliza a função showAnimatedSkeleton que tem o closure SkeletonLayerAnimation onde você pode definir sua animação customizada.

public typealias SkeletonLayerAnimation = (CALayer) -> CAAnimation

Você pode chamar esta função assim:

view.showAnimatedSkeleton { (layer) -> CAAnimation in
  let animation = CAAnimation()
  // Customize here your animation

  return animation
}

Está disponível SkeletonAnimationBuilder. É um construtor para SkeletonLayerAnimation.

Hoje, você pode criar sliding animations para gradientes, decidindo a direction e setando a duration da animaçāo (padrão = 1.5s).

// func makeSlidingAnimation(withDirection direction: GradientDirection, duration: CFTimeInterval = 1.5) -> SkeletonLayerAnimation

let animation = SkeletonAnimationBuilder().makeSlidingAnimation(withDirection: .leftToRight)
view.showAnimatedGradientSkeleton(usingGradient: gradient, animation: animation)

GradientDirection é um enum, com os seguintes cases:

Direction	Preview
.leftRight
.rightLeft
.topBottom
.bottomTop
.topLeftBottomRight
.bottomRightTopLeft

😉 TRUQUE! Existe outra forma de criar sliding animations, apenas usando este atalho:

let animation = GradientDirection.leftToRight.slidingAnimation()

👨‍👧‍👦 Hierarquia

Já que SkeletonView é recursiva, e queremos que o skeleton seja muito eficiente, queremos parar a recursão assim que possível. Por este motivo, você deve setar a container view como Skeletonable, porque o Skeleton vai parar de procurar por subviews skeletonable assim que a view não for mais skeletonable, quebrando a recursão.

Porque uma imagem vale mais que mil palavras:

ìsSkeletonable= ☠️

Configuration	Result

📚 Documentação

Em breve...😅

📬 Próximos passos

• Setar o percentual de preenchimento da última linha em elementos de várias linhas
• Adicionar mais animações de gradiente
• Suporte para resizable cells
• Compatível com CollectionView
• Compatível com tvOS
• Adicionar recovery state
• Aparência padrão customizável
• Compatível com coleções customizáveis
• Adicionar animações quando mostra/esconde os skeletons
• Compatível com MacOS e WatchOS

❤️ Contribuindo

Este é um projeto de código aberto, então sinta-se a vontade para contribuir. Como?

• Abra uma issue.
• Envie feedback por email.
• Proponha seus próprios fixes, sugestões e abra um pull request com as alterações.

Ver todos os contribuidores

Projeto gerado com SwiftPlate

📢 Menções

• iOS Dev Weekly #327
• Hacking with Swift Articles
• Top 10 Swift Articles November
• 30 Amazing iOS Swift Libraries (v2018)
• AppCoda Weekly #44
• iOS Cookies Newsletter #103
• Swift Developments Newsletter #113
• iOS Goodies #204
• Swift Weekly #96
• CocoaControls
• Awesome iOS Newsletter #74

👨🏻‍💻 Autor

• Juanpe Catalán

👮🏻 Licença

MIT License

Copyright (c) 2017 Juanpe Catalán

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.