Skip to content

Latest commit

 

History

History
247 lines (185 loc) · 10.7 KB

README.md

File metadata and controls

247 lines (185 loc) · 10.7 KB

License

WARNING ⚠️

This was something I wrote 2 months into learning swift and iOS development and with my current knowledge, this is terrible code. it has strict rules you must follow for it to work properly, and even then you must be careful how you use it and it has it's limitations (for example using it inside tableview or collection view cells is really complicated and hard and inefficient)

you CAN use it, but there are a lot of obstacles you will face. I'm leaving this repo open in case anyone has been using it and has learned how to navigate the restrictions and terrible code.

I may update this to a new, proper framework in the future but there are no current plans for that right now.

preview

This package includes three components:

  1. UIRadioButton
  2. UICheckboxModern
  3. UICheckboxClassic

Usage

Install:

  • Option 1: add pod 'UIButtonExtension', '~> 0.3' to your Podfile.
UIRadioButton

The UIRadioButton instance will have some attributes by default. you can customize these as you wish. to change the size of the button you only need to change the height of the instance.

to have the common Radio Button functionality where clicking one button disables the rest, you can relate these buttons inside an array by using a relate function.

import UIButtonExtension

let radioButton1 = UIRadioButton()
let radioButton2 = UIRadioButton()
let radioButton3 = UIRadioButton()
let radioButton4 = UIRadioButton()

radioButton1.relate(otherUIRadioButtons: [radioButton2, radioButton3]) //these four buttons are now related and only one can be active at a time.

Since UIRadioButton is of type UIView, to use an addTarget method you have to use the button inside the radioButton

import UIButtonExtension

let radioButton1 = UIRadioButton()

radioButton1.button.addTarget(self, action: #selector(example(_:)), for: .touchUpInside)

The UIRadioButton is made of two parts, the outer circle (which is of type Button) and the inner circle for when it's actively selected. to customize aspects of the button you can use:

import UIButtonExtension

let radioButton = UIRadioButton()

radioButton.color = .red           //changes the color of the outer circle to red.
radioButton.selectedColor = .green //changes the color of the inner circle to green
radioButton.borderWidth = 5        //changes the width of the outer circle to 5
radioButton.cornerRadius = 20      //changes the cornerRadius of the button to 20. (no longer a circle)
radioButton.selectedSize = 0.8     //changes the ratio of the inner circle size to the outer circle, only available from 0 to 1

The UIRadioButton can take in string to show in 4 corners:

import UIButtonExtension

let radioButton = UIRadioButton()

radioButton.leftText(text: String)   // adds a label to the left of the button and adds the inserted
radioButton.rightText(text: String)  // adds a label to the right of the button and adds the inserted
radioButton.topText(text: String)    // adds a label to the top of the button and adds the inserted
radioButton.bottomText(text: String) // adds a label to the bottom of the button and adds the inserted

by default the text will have a dynamic font size which adapts to the height of the button and the default system font and color. to change these you may use these:

import UIButtonExtension

let radioButton = UIRadioButton()

radioButton.fontSize = 25                            // change the size of the font
radioButton.font = UIFont(name: "Example", size: 20) // change the font of the text
radioButton.textColor = .blue                        // change the color of the text

Each instance of the UIRadioButton will have a randomly generated id (NSUUID) which you can change. each instance is also animated by default.

import UIButtonExtension

let radioButton = UIRadioButton()

print(radioButton.id)          //prints the current radioButton id
radioButton.id = "lorem Ipson" //changes the radioButton id to "lorem Ipson"
radioButton.animate = false    //disables the selection animation

to understand the current status of the button to see wether it's selected or not you can use isSelected.

import UIButtonExtension

let radioButton = UIRadioButton()

if radioButton.isSelected == true {
    //do stuff here
}

UICheckboxModern

The UICheckboxModern instance will have some attributes by default. you can customize these as you wish. to change the size of the button you only need to change the height of the instance. when clicked in modern style, the box gets filled by color and the checkmark resides inside the container box. The UICheckboxModern is made of two parts, the containing box and the checkmark for when it's actively selected. to customize aspects of the button you can use:

let checkboxModern = UICheckboxModern()

checkboxModern.color = .red           //changes the color of the containing box to red.
checkboxModern.selectedColor = .green //changes the color of the checkmark background to green
checkboxModern.borderWidth = 5        //changes the width of the containing box to 5
checkboxModern.checkedImage = UIImage(named: "how dare you change my default image.png") //changes the check mark image to what ever you like...
checkboxModern.cornerRadius = 5       //changes the corner radius of the containing box, can change value to make it a circle

The UICheckboxModern can take in String to show in 4 corners:

import UIButtonExtension

let checkboxModern = UICheckboxModern()

checkboxModern.leftText(text: String)   // adds a label to the left of the button and adds the inserted
checkboxModern.rightText(text: String)  // adds a label to the right of the button and adds the inserted
checkboxModern.topText(text: String)    // adds a label to the top of the button and adds the inserted
checkboxModern.bottomText(text: String) // adds a label to the bottom of the button and adds the inserted

by default the text will have a dynamic font size which adapts to the height of the button and the default system font and color. to change these you may use these:

import UIButtonExtension

let checkboxModern = UICheckboxModern()

checkboxModern.fontSize = 25                            // change the size of the font
checkboxModern.font = UIFont(name: "Example", size: 20) // change the font of the text
checkboxModern.textColor = .blue                        // change the color of the text

Each instance of the UICheckboxModern will have a randomly generated id (NSUUID) which you can change. each instance is also animated by default.

import UIButtonExtension

let checkboxModern = UICheckboxModern()

print(checkboxModern.id)          //prints the current checkboxModern id
checkboxModern.id = "lorem Ipson" //changes the checkboxModern id to "lorem Ipson"
checkboxModern.animate = false    //disables the selection animation

to understand the current status of the button to see wether it's selected or not you can use isSelected. keep in mind that isSelected is a read only property and only changes when the button is pressed.

import UIButtonExtension

let checkboxModern = UICheckboxModern()

if checkboxModern.isSelected == true {
    //do stuff here
}

UICheckboxClassic

The UICheckboxClassic instance will have some attributes by default. you can customize these as you wish. to change the size of the button you only need to change the height of the instance. when clicked in type 2, the check mark pops out of the frame a little to create it's unique visual style. keep in mind, if the width of the button is not the same as the height then the location of the checkmark will change based on the X axis. The UICheckboxClassic is made of two parts, the containing box and the checkmark for when it's actively selected. to customize aspects of the button you can use:

import UIButtonExtension

let checkboxClassic = UICheckboxClassic()

checkboxClassic.color = .red           //changes the color of the containing box to red.
checkboxClassic.selectedColor = .green //changes the color of the checkmark background to green
checkboxClassic.borderWidth = 5        //changes the width of the containing box to 5
checkboxClassic.checkedImage = UIImage(named: "how dare you change my default image.png") //changes the check mark image to what ever you like...
checkboxClassic.cornerRadius = 5       //changes the corner radius of the containing box, can change value to make it a circle

The UICheckBoxClassic can take in String to show in 4 corners:

import UIButtonExtension

let checkboxClassic = UICheckboxClassic()

checkboxClassic.leftText(text: String)   // adds a label to the left of the button and adds the inserted
checkboxClassic.rightText(text: String)  // adds a label to the right of the button and adds the inserted
checkboxClassic.topText(text: String)    // adds a label to the top of the button and adds the inserted
checkboxClassic.bottomText(text: String) // adds a label to the bottom of the button and adds the inserted

by default the text will have a dynamic font size which adapts to the height of the button and the default system font and color. to change these you may use these:

import UIButtonExtension

let checkboxClassic = UICheckboxClassic()

checkboxClassic.fontSize = 25                            // change the size of the font
checkboxClassic.font = UIFont(name: "Example", size: 20) // change the font of the text
checkboxClassic.textColor = .blue                        // change the color of the text

Each instance of the UICheckboxClassic will have a randomly generated id (NSUUID) which you can change. each instance is also animated by default.

import UIButtonExtension

let checkboxClassic = UICheckboxClassic()

print(checkboxClassic.id)          //prints the current checkboxClassic id
checkboxClassic.id = "lorem Ipson" //changes the checkboxClassic id to "lorem Ipson"
checkboxClassic.animate = false    //disables the selection animation

to understand the current status of the button to see wether it's selected or not you can use isSelected. keep in mind that isSelected is a read only property and only changes when the button is pressed.

import UIButtonExtension

let checkboxClassic = UICheckboxClassic()

if checkboxClassic.isSelected == true {
    //do stuff here
}

Contact me:

this is my first ever library, be gentle 😁

Email: [email protected]

Twitter: @shadow_of_arman

Instagram: shadowofarman