From ced600412552b65fe8cb735bb59852807e01da4e Mon Sep 17 00:00:00 2001 From: Emre Armagan Date: Sun, 5 Jan 2025 19:38:58 +0100 Subject: [PATCH] update README --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 75b4a5e..3813734 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ SYBanner is a simple and clean banner library for iOS. It supports various banne [📖 Documentation](https://emrearmagan.github.io/SYBanner/)
- +
> **⚠️ Important** @@ -36,7 +36,7 @@ SYBanner is a simple and clean banner library for iOS. It supports various banne ##### SYSimpleBanner - + ```swift let banner = SYBanner("Link copied", direction: .top) @@ -44,7 +44,7 @@ banner.present() ``` ##### SYBanner: - + ```swift let banner = SYDefaultBanner("A Banner with just a text", subtitle: "{subtitle}", direction: .top) @@ -52,7 +52,7 @@ banner.present() ``` ##### SYCardBanner - + The `SYCardBanner` provides a customizable and visually appealing card-style banner that can include titles, subtitles, buttons, and custom views. It is designed to offer a clean and engaging way to present information or actions to users. However, it's important to note that this is still a banner and can be dismissed by the user at any time. Your app should not depend on the `SYCardBanner` for critical actions or information. If you need to present a modal page where the user cannot leave, please check out [ModalKit](https://github.com/emrearmagan/ModalKit) which may be more suited. @@ -100,9 +100,9 @@ SYBanner provides a simple way to customize its appearance and behavior using Co
- - - + + +
@@ -149,8 +149,8 @@ banner.present() The SYBannerQueue system provides queue management to handle multiple banners. It ensures that banners are displayed sequentially, limits the number of banners visible at a time, and automatically adjusts the position of banners when others are dismissed.
- - + +
- **Stacking**: Manage multiple banners and define how many can appear simultaneously. @@ -184,8 +184,8 @@ banner.dismiss() ### Presenter The SYBannerPresenter protocol and its various implementations define how banners are presented and dismissed with animations. Presenters control the lifecycle of banners and provide the flexibility to customize their animations for a wide range of use cases.
- - + +
##### Using a Presenter @@ -194,10 +194,10 @@ Each banner has a presenter property that determines its animation behavior. For | Presenter | Demo | | -------- | ---- | -| *Default* | | -| *Fade* | | -| *Scale* | | -| *Bounce* | | +| *Default* | | +| *Fade* | | +| *Scale* | | +| *Bounce* | | ```swift @@ -236,7 +236,7 @@ class CustomSlidePresenter: SYDefaultPresenter { Highlighters define the visual feedback when users interact with a banner, such as touch events like taps or drags. They are used to provide animations that emphasize the interaction, such as scaling or alpha changes. `SYBanner` includes the `SYBannerHighlighter` protocol, which allows developers to define custom highlighter behavior. It also provides a default implementation, SYDefaultHighlighter, for standard highlighting effects. - + ##### Using a Highlighter You can assign a highlighter to a banner by setting its highlighter property. By default, banners use SYDefaultHighlighter.