Releases: material-foundation/cocoapods-catalog-by-convention
v2.5.2
v2.5.1
Fix a runtime crash that occurred when the PhotoFoundation framework was included in an app.
Source changes
v2.5.0
There is now a new NSDictionary
property in CBCNode
called metadata. It is meant to store all the information regarding an example
rather than using separate methods as previously done. With that said, we offer backwards compatibility and still allow the usage of methods to provide example information.
Before:
+ (NSArray *)catalogBreadcrumbs {
return @[ @"Activity Indicator", @"Activity Indicator" ];
}
+ (NSString *)catalogDescription {
return @"Activity Indicator is a visual indication of an app loading content. It can display how "
@"long an operation will take or visualize an unspecified wait time.";
}
+ (BOOL)catalogIsPrimaryDemo {
return YES;
}
+ (BOOL)catalogIsPresentable {
return YES;
}
After:
+ (NSDictionary *)catalogMetadata {
return @{@"breadcrumbs": @[ @"Activity Indicator", @"Activity Indicator" ],
@"description": @"Activity Indicator is a visual indication of an app loading content. It can display how "
@"long an operation will take or visualize an unspecified wait time.",
@"primaryDemo": @YES,
@"presentable": @YES};
}
Source changes
- added a new metadata property that will hold all the key/values for that node. Also code refactoring (#27) (Yarden Eitan)
API changes
CBCBreadcrumbs
new constant: CBCBreadcrumbs
CBCNode
new property: metadata
in CBCNode
removed property: nodeDescription
in CBCNode
modified method: -exampleDescription
in CBCNode
Type of change: | Swift declaration |
---|---|
From: | func exampleDescription() -> String |
To: | func exampleDescription() -> String? |
modified method: -exampleDescription
in CBCNode
Type of change: | Declaration |
---|---|
From: | - (nonnull NSString *)exampleDescription; |
To: | - (nullable NSString *)exampleDescription; |
CBCRelatedInfo
new constant: CBCRelatedInfo
CBCIsDebug
new constant: CBCIsDebug
CBCIsPresentable
new constant: CBCIsPresentable
CBCIsPrimaryDemo
new constant: CBCIsPrimaryDemo
CBCDescription
new constant: CBCDescription
CBCStoryboardName
new constant: CBCStoryboardName
v2.4.1
Add exampleRelatedInfo
to the CBCNode header for external invocation.
Source changes
- add exampleRelatedInfo to header file (#26) (Yarden Eitan)
v2.4.0
- Now you can add the method
catalogRelatedInfo
that returns an NSURL to your example, if you wish to link to related information and resources. - A performance improvement when fetching all viable classes to build the navigation tree.
Source changes
- Add "related info" URLs to examples (#24) (Adrian Secord)
- [Runtime] Only select UIViewController subclasses (#22) (Robert Moore)
v2.3.1
minor bug fix introduced in 2.3.0 that returns wrong boolean values.
Source changes
v2.3.0
This minor release adds two new functionalities that support our new Dragons app.
New features
-
It's now possible to call
CBCCreatePresentableNavigationTree
to create a navigation tree that only consists of examples that implement thecatalogIsPresentable
method and returnYES
to it. -
CBCNode
now has a new property calleddebugLeaf
which is also aCBCNode
. If an example implements thecatalogIsDebug
method and returnsYES
, then that example will become thedebugLeaf
. When thedebugLeaf
is set, then in the Dragons app it will become the initial view controller in the navigation.
NOTE: If there are multiple examples that return YES
to catalogIsDebug
then the last class that is parsed while going through the hierarchy is the one to be set as the debugLeaf
.
Source changes
- Additional functionality to CbC to support Dragons (#19) (Yarden Eitan)
Non-source changes
- Remove arc support. (#18) (featherless)
- Bump the kokoro runner version to v2.1.1. (Jeff Verkoeyen)
- Replace Carthage support with bazel support (#17) (featherless)
v2.2.0
This minor release introduces support for Carthage.
New features
It's now possible to define multiple paths to a single example. Simply return an array of arrays
of breadcrumbs from the catalogBreadcrumbs
implementation.
Source changes
Non-source changes
- Disable code coverage reporting. (#16) (featherless)
- Add kokoro continuous build script. (#15) (featherless)
- Fix the xcodeproj. (#14) (featherless)
- Add support for Carthage. (Jeff Verkoeyen)
- fixed method signature (randallli)
- Add .swift-version file. (Jeff Verkoeyen)
v2.1.1
Release 2.1.0
2.1.0
- Add tvOS as a platform.