Skip to content

Latest commit

 

History

History
785 lines (419 loc) · 32.3 KB

CHANGELOG.md

File metadata and controls

785 lines (419 loc) · 32.3 KB

Changelog

12.0.0-alpha.0 (2025-01-14)

⚠ BREAKING CHANGES

  • Dropped support for Angular 18. #296

Features

  • Added support for Angular 19. #296

11.2.0 (2025-01-03)

  • Mock SkyHelpService in code examples. #294

11.1.0 (2024-11-20)

  • Option to use web containers by holding meta or control key. #279

11.0.0 (2024-09-11)

⚠ BREAKING CHANGES

  • Dropped support for Angular 17. #291

Features

  • Added support for Angular 18. #291

11.0.0-alpha.0 (2024-07-19)

⚠ BREAKING CHANGES

  • Dropped support for Angular 17. #291

Features

  • Added support for Angular 18. #291

10.5.2 (2024-06-05)

  • Update SkyDocsSourceCodeProvider to be provided in root to allow for standalone component overwriting. #289

10.6.0 (2024-06-28)

  • Add @skyux/icon to code example dependencies. #000

10.5.1 (2024-05-29)

  • Update property definition table headers so content scrolls under. #288

10.5.0 (2024-05-23)

  • Make property definition table headers sticky. #287

10.4.0 (2024-05-23)

  • Update control panel radio groups to use heading text inputs. #286

10.3.0 (2024-05-22)

  • Add support for Angular input signals. #285

10.2.1 (2024-05-21)

10.2.0 (2024-05-15)

  • Added the ability to provide a custom control panel for demos. #283

10.1.1 (2024-05-10)

  • Switched to using provideInitialTheme and streamlined boilerplate code for examples. #281
  • Exposed help inline inputs on control panel checkbox. #282

10.1.0 (2024-04-16)

  • Added @skyux/help-inline dependency and bumped ng2-dragula version. #280

10.0.1 (2024-04-04)

  • Updated dependencies to work with Angular 17.3. #278

10.0.0 (2024-03-27)

⚠ BREAKING CHANGES

  • Dropped support for Angular 16. #271

Features

  • Added support for Angular 17. #271

10.0.0-alpha.3 (2023-03-25)

  • Set code example project target to ES2015 to resolve an issue when running code examples in StackBlitz. #276

9.2.1 (2023-03-25)

  • Set code example project target to ES2015 to resolve an issue when running code examples in StackBlitz. #275

10.0.0-alpha.2 (2024-03-15)

  • Update dependencies. #274

10.0.0-alpha.1 (2024-02-29)

  • Add ability to mark features as being in preview. #272 #273

9.2.0 (2024-02-29)

  • Add ability to mark features as being in preview. #272

10.0.0-alpha.0 (2024-01-30)

⚠ BREAKING CHANGES

  • Dropped support for Angular 16. #271

Features

  • Added support for Angular 17. #271

9.1.5 (2023-10-09)

  • Allow a demo page to be created without the moduleName input. #268

9.1.4 (2023-09-27)

  • Fixed the code example editor service to load examples where dragula is required. #267

9.1.3 (2023-09-21)

  • Fixed the code example editor service to use the major version of Angular packages to determine SemVer range. #266

9.1.2 (2023-09-21)

  • Fixed the code example editor service to use the latest supported version of @skyux/icons, @skyux/core, and @angular/core. #264

9.1.1 (2023-09-19)

  • Updated styles for removal of previous compat stylesheets. #263

9.1.0 (2023-09-18)

  • Updated code example editor service to recognize standalone components. #262

9.0.0 (2023-09-14)

⚠ BREAKING CHANGES

  • Dropped support for Angular 15. #253

Features

  • Added support for Angular 16. #253
  • Updated code examples to use Angular 16 and SKY UX 9. #258
  • Added support for typedoc@~0.24.0. #254

9.0.0-alpha.5 (2023-09-07)

  • Fix multiple issues regarding the updates for SKY UX 9. #259

9.0.0-alpha.4 (2023-08-23)

  • Updated code examples to use Angular 16 and SKY UX 9. #258

9.0.0-alpha.3 (2023-08-22)

  • Handle the fact that default values are now treated as code. #257

9.0.0-alpha.2 (2023-08-22)

  • Handle cases where kindString is not available. #256

9.0.0-alpha.1 (2023-08-21)

  • Added support for typedoc@~0.24.0. #254

9.0.0-alpha.0 (2023-08-08)

⚠ BREAKING CHANGES

  • Dropped support for Angular 15. #253

Features

  • Added support for Angular 16. #253

8.0.3 (2023-05-16)

  • Switched code examples from web containers to angular-cli template. #250

8.0.2 (2023-05-12)

  • Enabled esModuleInterop for code example projects. #249

8.0.1 (2023-05-11)

  • Updated code examples to use Angular 15. #247

8.0.0 (2023-05-10)

⚠ BREAKING CHANGES

  • Dropped support for Angular 14. #246

Features

  • Added support for Angular 15. #246

7.2.0 (2023-04-24)

  • Added the ability to specify a anatomy thumbnail outside of the anatomy item so that it goes full wdith. #244

7.1.3 (2023-03-24)

  • Fixed component events to not be listed as optional. #241
  • Fixed union types to include quotes around string values. #242

7.1.2 (2023-03-14)

  • Changed URL to SKY UX icons to always point to the latest 5.x version. #239

7.1.1 (2022-12-15)

  • Updated code examples app component and main.ts to be strict mode compliant. #237

7.1.0 (2022-12-14)

  • Enabled TypeScript strict mode for StackBlitz code examples. #235

7.0.0 (2022-12-06)

⚠ BREAKING CHANGES

  • Dropped support for Angular 13. #224

Features

  • Added support for Angular 14. #224
  • Updated code examples to use Angular 14. #233

Bug fixes

  • Fix spacing between related links. #229

7.0.0-beta.3 (2022-11-18)

  • Updated code examples to use Angular 14. #233

7.0.0-beta.2 (2022-10-25)

  • Fix spacing between related links. #229

7.0.0-beta.1 (2022-10-19)

  • Fix additional source code paths not appears in component documentation. #225

6.0.0-beta.11 (2022-10-19)

  • Fix additional source code paths not appears in component documentation. #225 #226

7.0.0-beta.0 (2022-09-27)

⚠ BREAKING CHANGES

  • Dropped support for Angular 13. #224

Features

  • Added support for Angular 14. #224

6.0.0-beta.10 (2022-09-13)

  • Enable testing tab for component documentation. #223

6.0.0-beta.9 (2022-09-08)

  • Update code example service to handle spec files being included. #222

6.0.0-beta.8 (2022-09-01)

  • Fix class properties of an array of function to display properly. #220

6.0.0-beta.7 (2022-09-01)

  • Show static methods in a separate table with their fully qualified signature. #219

6.0.0-beta.6 (2022-08-24)

  • Moved code examples to their own tab. #217

6.0.0-beta.5 (2022-08-02)

  • Update demo control panel child components to emit initial values and replay those values if subscribed to after initialization of the control finishes. #215

6.0.0-beta.4 (2022-07-22)

  • Use description list for module info and move getter logic to setters. #214

6.0.0-beta.3 (2022-06-30)

  • Added support for marked@4.0.17. #212

6.0.0-beta.2 (2022-06-28)

  • Add Angular CDK to list of packages installed for StackBlitz examples. #211
  • Fixed method definitions to indicate when the method is a static method. #209

6.0.0-beta.1 (2022-04-19)

  • Fixed the SkyDocsCodeExamplesEditorService to install ng2-dragula@2.1.1. #207

6.0.0-beta.0 (2022-04-13)

Breaking changes

  • Dropped support for Angular 12. #206

New features

  • Added support for Angular 13. #206

4.10.0 (2022-03-22)

  • Added an alert to redirect consumers to the main documentation site. #202

4.9.7 (2021-12-03)

  • Fixed the SkyDocsCodeExamplesEditorService to set wildcard versions (e.g. '*') of SKY UX packages to ^4. #188

5.0.0-beta.13 (2022-02-23)

  • Fixed the SkyDocsTypeDocAdapterService to properly handle constructors that don't have parameters. #200

5.0.0-beta.12 (2022-02-18)

  • Fixed the SkyDocsTypeDocAdapterService to properly handle properties which are created as class constructor parameters. #199

5.0.0.beta.11 (2022-02-14)

  • Fixed the SkyDocsTypeDocAdapterService to properly handle interface methods, class method inputs, type aliases, and single accessor properties. #197

5.0.0-beta.10 (2022-02-04)

  • Removed an outdated reference to entry components. #193

5.0.0-beta.9 (2022-01-06)

  • Added the stylesheets input to the SkyDocsCodeExamplesComponent to provide additional global stylesheets to StackBlitz. #191

5.0.0-beta.8 (2021-12-09)

  • Added the ability to document classes outside of a component's main module path. #179

5.0.0-beta.7 (2021-12-06)

  • Fixed the SkyDocsCodeExamplesEditorService to set wildcard versions (e.g. '*') of SKY UX packages to ^5. #189

5.0.0-beta.6 (2021-12-01)

  • Fixed the code example editor to handle trailing commas in the demo module's exports section. #186

5.0.0-beta.5 (2021-11-30)

  • Fixed the SkyDocsTypeDocAdapterService to properly handle deprecated, required, and optional accessor properties. #185

5.0.0-beta.4 (2021-11-17)

  • Fixed the SkyDocsTypeDocAdapterService to properly handle accessor property descriptions. #183

5.0.0-beta.3 (2021-11-16)

  • Fixed the StackBlitz code examples to work with Angular 12. #182

5.0.0-beta.2 (2021-10-12)

  • Migrated to Angular CLI. #177

5.0.0-beta.1 (2021-09-28)

  • Fixed the SkyDocsTypeDocAdapterService to properly handle index signatures when using typedoc@~0.20.0 and above. #176

5.0.0-beta.0 (2021-09-28)

  • Initial 5.0.0-beta release. #175

4.9.6 (2021-09-21)

  • Fixed the SkyDocsSourceCodeService to handle both encoded and decoded URI strings for the source code. #173

4.9.5 (2021-08-25)

  • Fixed the NPM release. #172

4.9.4 (2021-08-25)

  • [This release is broken. Upgrade to version 4.9.5.]
  • Fixed the SkyDocsTypeDocAdapterService to handle default values generated by typedoc@~0.20.0. #170

4.9.3 (2021-08-13)

  • Fixed the SkyDocsTypeDocAdapterService to use SkyDocsTypeDefinitionsProvider.anchorIds if the anchorId property has not been set on the individual type definitions. #167

4.9.2 (2021-08-02)

  • Fixed the demo theme control panel to dynamically update when the theme is externally changed. #165

4.9.1 (2021-06-15)

  • Added support for marked@2.0.7. #163

4.9.0 (2021-04-15)

  • Updated the StackBlitz demos to use Angular 9. #160
  • Fixed the StackBlitz demos to properly display Font Awesome and SKY UX icons. #160

4.8.1 (2021-01-20)

  • Added support for marked@1.2.7. #156

4.8.0 (2020-12-08)

  • Added the disabled property to the SkyDocsDemoControlPanelRadioGroupComponent and SkyDocsDemoControlPanelCheckboxComponent to disable the demo form controls. #154

4.7.4 (2020-11-09)

  • Fixed the type definitions service to support type operator properties (e.g., keyof). #153

4.7.3 (2020-10-12)

  • Fixed the interface and class type definitions components to support "type literal" properties. #148

4.7.2 (2020-10-1)

  • Fixed the interface definition component to hide optional and required statuses for properties. #145

4.7.1 (2020-09-25)

  • Fixed the type definitions service to handle additional type formats. #142

4.7.0 (2020-09-23)

  • Added SkyThemeService to the app module's providers array for Stackblitz demos. #137
  • Updated the SkyDocsCodeExampleComponent to set the theme in Stackblitz demos based on the SkyThemeService. #138

4.6.0 (2020-09-16)

  • Added the theme property to the SkyDocsCodeExampleComponent to load Stackblitz demos in modern theme. #130

4.5.3 (2020-09-15)

  • Fixed the demo page component to retain URL params in the sidebar nav when linking between repos. #128

4.5.2 (2020-09-11)

  • Fixed the SkyDocsSupportalService calls to properly retain the svcid URL parameter. #126

4.5.1 (2020-09-09)

  • Fixed the demo page component to properly render links in the sidebar nav when components have URL parameters. #121

4.5.0 (2020-09-04)

  • Added support for marked@1.1.1. #120

4.4.4 (2020-09-03)

  • Reverted the moment package version to 0.8.0 since 0.8.2 includes breaking changes. #119

4.4.3 (2020-09-01)

  • Fixed the type definition service to handle classes with the @Injectable decorator. #116

4.4.2 (2020-08-31)

  • Fixed the type alias definition component to handle undocumented parameters for function types. #115

4.4.1 (2020-08-27)

  • Fixed the property definition component to hide default values for Output properties. #113

4.4.0 (2020-08-27)

  • Added the sky-docs-thumbnail component. #106
  • Fixed the directive definition component to properly parse Input property bindings (e.g., @Input('foobar')). #107
  • Fixed the parameter definition component to properly handle parameters of type "call signature". #110

4.3.2 (2020-08-26)

  • Fixed the class definition component to properly display default and required values. #102
  • Fixed the parameter definition component to properly format complex property types. #103

4.3.1 (2020-08-21)

  • Fixed the property definition component to properly display call signatures. #94
  • Fixed the directive definition component to properly display complex selectors. #101
  • Fixed the enumeration definition component to properly format markdown in the description. #100

4.3.0 (2020-08-20)

  • Added the modern property to SkyDocsComponentInfo. #95
  • Added class definitions to the type definitions component. #93
  • Fixed the type definitions component to display a property's array type arguments properly. #91
  • Fixed the service definitions component to properly display outputs if a class does not include inputs. #96

4.2.1 (2020-08-05)

  • Fixed the anchor link service to properly format known type names when they immedately precede a property. #86

4.2.0 (2020-07-21)

  • Added the ability to hide restricted items in the sidebar navigation. #79

4.1.0 (2020-07-01)

  • Added restricted property to SkyDocsComponentInfo. #73

4.0.0 (2020-05-29)

New features

  • Added SkyDocsHeadingAnchorModule, SkyDocsMarkdownModule, SkyDocsModuleInfoModule, and SkyDocsSafeHtmlModule to the exports API. #57
  • Added support for @angular/core@^9. #32
  • Updated the pipeline to transpile to the Angular Package Format. #32

Bug fixes

  • Added a global style reference for the native code element to match what's provided by @blackbaud/skyux-lib-stache. #60
  • Fixed the type definition components to run the markdown pipe in the correct order. #59

Breaking changes

  • Upgraded all @blackbaud/skyux-lib-* dependencies to 4.0.0. #61
  • Dropped support for rxjs@5. Consumers may install rxjs-compat@^6 to support older versions of rxjs. #32

4.0.0-rc.9 (2020-05-28)

  • Upgraded all @blackbaud/skyux-lib-* dependencies to 4.0.0. #61

4.0.0-rc.8 (2020-05-22)

  • Added a global style reference for the native code element to match what's provided by @blackbaud/skyux-lib-stache. #60

4.0.0-rc.7 (2020-05-20)

  • Fixed the type definition components to run the markdown pipe in the correct order. #59

4.0.0-rc.6 (2020-05-19)

  • Added code element styles to the safe HTML component. #58

4.0.0-rc.5 (2020-05-19)

  • Added SkyDocsHeadingAnchorModule, SkyDocsMarkdownModule, SkyDocsModuleInfoModule, and SkyDocsSafeHtmlModule to the exports API. #57

4.0.0-rc.4 (2020-05-01)

  • Added bug fixes and features from the master branch. #55

3.3.0 (2020-04-30)

  • Added a theme switcher control panel to the demo component. #52

4.0.0-rc.3 (2020-04-28)

  • Added bug fixes and features from the master branch. #51

3.2.1 (2020-04-27)

  • Fixed the anchor link service to handle types wrapped within markdown links. #49

4.0.0-rc.2 (2020-04-16)

  • Added bug fixes and features from the master branch. #44

3.2.0 (2020-03-30)

  • Added a heading attribute to the demo component to allow consumers to provide a custom heading. #26
  • Added the ability to provide additional content for the module info component. #42
  • Updated the default text in the module info component's Installation popover. #42
  • Fixed the pipe definition component to display the input value's property name. #27
  • Fixed the heading styles to conform to the heading styles provided in the Stache component library. #42
  • Fixed the Design/Development tabset border to extend to the full width of the page. #42
  • Fixed the method definition component to decode special characters in the method signature. #42
  • Fixed the demo control panel component to display properly when only the Reset button is shown. #42
  • Fixed the method definition component to display required parameters properly. #42
  • Fixed the property definition component to provide in-page links to known types in the deprecation messages. #42

4.0.0-rc.1 (2020-02-24)

Bug fixes

  • Fixed the exports API to export the SkyDemoModule. #34

4.0.0-rc.0 (2020-02-22)

New features

Breaking changes

  • Dropped support for rxjs@5. Consumers may install rxjs-compat@^6 to support older versions of rxjs. #32

3.1.0 (2020-01-29)

  • Added a reset emitter to the demo control panel component that fires when users click the reset button. #21
  • Fixed the code examples editor service to provide SkyAppLocaleProvider when running code examples in StackBlitz. #19
  • Fixed the module info component's code element styles to match Stache code snippet styles. #23

3.0.0 (2020-01-24)

  • Initial major release.

3.0.0-alpha.36 (2020-01-21)

  • Fixed the demo component to hide the options dropdown if no control panels exist.

3.0.0-alpha.35 (2020-01-17)

  • Fixed a bug where code example files were being shared between similarly named headings. #15
  • Adopted latest version of SkyImageModule (from @blackbaud/skyux-lib-media@1.2.0) which addresses some accessibility and responsiveness issues. #15
  • Added feature to allow custom content to be included under the "Development" tab. #15

3.0.0-alpha.34 (2020-01-10)

  • Removed the image component caption "Do" and "Don't" prefixes. #14

3.0.0-alpha.33 (2020-01-10)

  • Fixed an implementation problem of the package marked that affected Internet Explorer 11. #13

3.0.0-alpha.32 (2020-01-10)

  • Altered spacing between design guidelines thumbnails.
  • Added space character between "optional" text on the anatomy item component marker.

3.0.0-alpha.31 (2020-01-09)

  • Fixed design guideline thumbnail component to properly wrap multiple images.

3.0.0-alpha.30 (2020-01-09)

  • Created anatomy module, added columns for design guideline thumbnails. #12

3.0.0-alpha.29 (2020-01-03)

  • Fixed the demo control panel checkbox component to signal changes when the reset button is clicked.

3.0.0-alpha.28 (2020-01-03)

  • Added global style sheet to be used for table styles.

3.0.0-alpha.27 (2019-12-13)

  • Changed the anatomy component's thumbnailPath input to imagePath to be consistent with the SKY UX documentation SPA's component.
  • Isolated heading styles for various components to make them work in isolation.

3.0.0-alpha.26 (2019-12-11)

  • Updated the sidebar header. #7

3.0.0-alpha.25 (2019-12-02)

  • Bugfix to allow popovers (and all future SPAs) to be marked as active. #5

3.0.0-alpha.24 (2019-11-22)

  • Added the SkyDocsSupportalService to allow consumers to fetch a list of component information. #4

3.0.0-alpha.23 (2019-11-15)

  • Fixed the demo page component's HTTP GET request to reference the correct supportal URL.

3.0.0-alpha.22 (2019-11-12)

  • Added SkyDocsToolsOptions provider.
  • Added documentation for the demo, demo page, and code examples components.

3.0.0-alpha.21 (2019-11-12)

  • Fixed the module info component to generate the correct URL for NPM packages.

3.0.0-alpha.20 (2019-11-06)

  • Added the SkyDocsToolsModule which exports the most commonly used modules.

3.0.0-alpha.19 (2019-10-31)

  • Added mobile responsive view for the property definitions component.

3.0.0-alpha.18 (2019-10-30)

  • Added the SkyDocsDemoControlPanelRadioChoice interface.
  • Changed the name of the sourceCodeLocation input on the code example component to sourceCodePath.
  • Changed the name of the sourceCodeLocation input on the type definitions component to moduleSourceCodePath.
  • Changed the name of the sourceCodeLocation input on the demo page component to moduleSourceCodePath.
  • Fixed type definitions component to properly recognize required state on properties.

3.0.0-alpha.17 (2019-10-24)

  • Implemented call to supportal service to derive component sidebar navigation.
  • Fixed the code example editor service to support pre-release versions of NPM packages.

3.0.0-alpha.16 (2019-10-02)

  • Fixed the design guidelines thumbnail component to contrain video width to column width.

3.0.0-alpha.15 (2019-10-02)

  • Fixed the code example component to display code example headings.

3.0.0-alpha.14 (2019-10-02)

  • Added headingStyle to the design guidelines section component.
  • Added videoSource to the design guidelines thumbnail component.

3.0.0-alpha.13 (2019-10-02)

  • Fixed the SkyDocsTypeDefinitionsModule to provide the SkyDocsTypeDefinitionsFormatService.

3.0.0-alpha.12 (2019-10-02)

  • Added inline mode for markdown pipe.
  • Code cleanup.

3.0.0-alpha.11 (2019-10-02)

  • Fixed the demo control panel component to watch for changes to dynamically added controls.

3.0.0-alpha.10 (2019-09-23)

  • Fixed scroll-to behavior for dynamic links.

3.0.0-alpha.9 (2019-09-23)

  • Implemented permalinks for tabs.
  • Fixed positioning of scrolling behavior for heading anchor component.

3.0.0-alpha.8 (2019-09-23)

  • Added safe HTML component.
  • Added heading anchor component.
  • Added automatic link generator for TypeScript types.
  • Style adjustements.

3.0.0-alpha.7 (2019-08-22)

  • Adjusted styles and placement for property definition "required" and "deprecated" labels.
  • Added toggle button to show and hide the behavior demo.

3.0.0-alpha.6 (2019-06-25)

  • Removed "Overview" heading from demo page summary.

3.0.0-alpha.5 (2019-06-24)

  • Added sidebar navigation.

3.0.0-alpha.4 (2019-06-24)

  • Added support for Angular pipe definitions.
  • Added components to display design guidelines.

3.0.0-alpha.3 (2019-06-19)

  • Added components to support TypeDoc JSON output.

3.0.0-alpha.2 (2019-06-05)

  • Added checks to hide headings for demos and code examples if they do not exist.

3.0.0-alpha.1 (2019-06-04)

  • Updated wording for module info component.
  • Added peer dependencies.

3.0.0-alpha.0 (2019-06-03)

  • Initial alpha release.