Skip to content

Commit 98f27c4

Browse files
Merge pull request #15 from SimformSolutionsPvtLtd/update_readme
Updated readme.md file
2 parents 5e400e1 + efb3d91 commit 98f27c4

File tree

7 files changed

+43
-36
lines changed

7 files changed

+43
-36
lines changed

Package.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
// swift-tools-version:5.2
1+
// swift-tools-version:5.7
22
// The swift-tools-version declares the minimum version of Swift required to build this package.
33

44
import PackageDescription
55

66
let package = Package(
77
name: "SSToastMessage",
88
platforms: [
9-
.iOS(.v13),
9+
.iOS(.v14),
1010
.macOS(.v10_15)
1111
],
1212
products: [

README.md

Lines changed: 35 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<a href="https://www.simform.com/"><img src="https://github.com/SimformSolutionsPvtLtd/SSToastMessage/blob/master/simformBanner.png"></a>
1+
![SSToastMessage Banner](banner.png)
22

33
SSToastMessage
44
=============
@@ -11,8 +11,15 @@ SSToastMessage
1111
[![PRs Welcome][PR-image]][PR-url]
1212
[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/simform)
1313

14+
Create Toast Views with Minimal Effort in SwiftUI Using SSToastMessage. SSToastMessage enables you to effortlessly add toast notifications, alerts, and floating messages to any view on both iPhone and macOS. With SSToastMessage, you can display left and right toast views over any top-level view, making it incredibly versatile and powerful. Designed to be simple, lightweight, and user-friendly, SSToastMessage allows you to show popups with a single line of code. Enhance your app's user experience with seamless and stylish notifications.
15+
16+
## Features
17+
18+
- [x] Customisable toast view
19+
- [x] Multiple options for show toast view
20+
- [x] Cross-Platform (iOS & macOS)
21+
- [x] Flexible Positioning
1422

15-
SSToastMessage is written in SwiftUI. It will add toast, alert, and floating message view over the top of any view. It is intended to be simple, lightweight, and easy to use. It will be a popup with a single line of code.
1623

1724
Screenshots
1825
---------
@@ -25,22 +32,26 @@ Setup Instructions
2532
------------------
2633
To integrate Toast-Swift into your Xcode project using CocoaPods, specify it in your `Podfile`:
2734
```ruby
28-
pod 'SSToastMessage', '~> 1.0.0'
35+
pod 'SSToastMessage'
2936
```
3037
and in your code add `import SSToastMessage`.
3138

3239
[Swift Package Manager](https://swift.org/package-manager/)
3340
------------------
3441
When using Xcode 11 or later, you can install `SSToastMessage` by going to your Project settings > `Swift Packages` and add the repository by providing the GitHub URL. Alternatively, you can go to `File` > `Swift Packages` > `Add Package Dependencies...`
3542

43+
dependencies: [
44+
.package(url: "https://github.com/SimformSolutionsPvtLtd/SSToastMessage.git", from: "1.0.0")
45+
]
3646

3747
## Manually
3848

39-
1. Add `MessageView.swift`, `DispatchWorkHolder.swift` and `View+Extension.swift` to your project.
49+
1. Add `MessageView.swift`, `DispatchWorkHolder.swift`, `ViewModel.swift` and `View+Extension.swift` to your project.
4050
2. Grab yourself a cold 🍺.
4151

4252
## Requirements
43-
* iOS 13+
53+
* iOS 14+
54+
* macos 13+
4455
* Xcode 11+
4556

4657
# Usage
@@ -98,7 +109,7 @@ struct ContentView: View {
98109
}
99110
}.padding(15)
100111
}
101-
.frame(width: UIScreen.main.bounds.width, height: 110)
112+
.frame(height: 110)
102113
.background(Color(red: 0.85, green: 0.65, blue: 0.56))
103114
}
104115
}
@@ -120,42 +131,37 @@ Way easy to customize!
120131

121132
Element | Declaration | Description
122133
--------|-----------|-----
123-
type | `type: MessageType` | set type of view alert, toast and float.
134+
type | `type: MessageType` | set type of view alert, toast and floater, left toast view and right toast view.
124135
position | `position: Position` | top or bottom (for default case it just determines animation direction).
125136
animation | `animation: Animation` | custom animation for message view sliding onto screen.
126-
autohideDuration | `autohideDuration: Double?` | time after which message view should disappear.
137+
horizontalPadding | `horizontalPadding: Double?` | for adding horizontalPadding in toast view.
138+
duration | `duration: Double?` | time after which message view should disappear.
127139
closeOnTap | `closeOnTap: Bool` | on message view tap it should disappear.
140+
closeOnTapOutside | `closeOnTapOutside: Bool` | on outside tap message view should disappear.
128141
onTap | `onTap: () -> Void` | on message view tap perform any action or navigation.
129142
onToastHide | `onToastHide: () -> Void` | on toast hide perform any action.
130-
closeOnTapOutside | `closeOnTapOutside: Bool` | on outside tap message view should disappear.
131143

132144

133145
See the demo project for more examples.
134146

135-
<h3><a href="https://github.com/SimformSolutionsPvtLtd"><u>🗂 Check out our other libraries→</u></a></h3>
147+
## 🤝 How to Contribute
148+
149+
Whether you're helping us fix bugs, improve the docs, or a feature request, we'd love to have you! :muscle:
150+
151+
Check out our [**Contributing Guide**](CONTRIBUTING.md) for ideas on contributing.
152+
153+
## Find this example useful? ❤️
154+
155+
Give a ⭐️ if this project helped you!
156+
157+
## Check out our other Libraries
158+
159+
<h3><a href="https://github.com/SimformSolutionsPvtLtd/Awesome-Mobile-Libraries"><u>🗂 Simform Solutions Libraries→</u></a></h3>
136160

137161

138162
## MIT License
139163

140-
Copyright (c) 2020 Simform Solutions
141-
142-
Permission is hereby granted, free of charge, to any person obtaining a copy
143-
of this software and associated documentation files (the "Software"), to deal
144-
in the Software without restriction, including without limitation the rights
145-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
146-
copies of the Software, and to permit persons to whom the Software is
147-
furnished to do so, subject to the following conditions:
148-
149-
The above copyright notice and this permission notice shall be included in all
150-
copies or substantial portions of the Software.
151-
152-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
153-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
154-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
155-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
156-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
157-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
158-
SOFTWARE.
164+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
159165

160166
[PR-image]:https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat
161167
[PR-url]:http://makeapullrequest.com

SSToastMessage.podspec

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,17 @@
88

99
Pod::Spec.new do |s|
1010
s.name = 'SSToastMessage'
11-
s.version = '1.0.0'
11+
s.version = '2.0.0'
1212
s.platform = :ios
1313
s.platform = :osx
1414
s.swift_versions = '5.0'
1515
s.summary = 'Simple popup view build in SwiftUI.'
1616
s.description = <<-DESC
17-
SSToastMessage is written purely in SwiftUI. It will add toast, alert,
18-
and floating message view over the top of any view. It is intended to b
19-
simple, lightweight, and easy to use. It will be a popup with a single line of
20-
code.
17+
Create Toast Views with Minimal Effort in SwiftUI Using SSToastMessage.SSToastMessage enables you to effortlessly add toast
18+
notifications, alerts, and floating messages to any view on both iPhone and macOS. With SSToastMessage, you can display left and
19+
right toast views over any top-level view, making it incredibly versatile and powerful. Designed to be simple, lightweight, and
20+
user-friendly, SSToastMessage allows you to show popups with a single line of code. Enhance your app's user experience with seamless
21+
and stylish notifications.
2122
DESC
2223

2324
s.homepage = 'https://github.com/SimformSolutionsPvtLtd/SSToastMessage'

banner.png

2 MB
Loading

demo.gif

-4.63 MB
Loading

screen_shots.png

-158 KB
Loading

simformBanner.png

-168 KB
Binary file not shown.

0 commit comments

Comments
 (0)