@skyux/flyout 5.5.0-alpha.0 → 5.5.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/documentation.json +1 -1
  2. package/esm2015/lib/modules/flyout/types/flyout-config.js.map +1 -1
  3. package/lib/modules/flyout/types/flyout-config.d.ts +1 -1
  4. package/package.json +20 -6
package/documentation.json CHANGED
@@ -1529,7 +1529,7 @@
1529
1529
  "isOptional": true
1530
1530
  },
1531
1531
  "comment": {
1532
- "shortText": "Specifies a unique key for the UI Config Service to retrieve stored settings from a database.\nThe UI Config Service saves configuration settings for users to preserve the width of\nthe flyout. For more information about the UI Config Service,\nsee [the sticky settings documentation](https://developer.blackbaud.com/skyux/learn/get-started/advanced/sticky-settings)."
1532
+ "shortText": "Specifies a unique key for the UI Config Service to retrieve stored settings from a database.\nThe UI Config Service saves configuration settings for users to preserve the width of\nthe flyout. For more information about the UI Config Service,\nsee [the sticky settings documentation](https://developer.blackbaud.com/skyux/learn/get-started/sticky-settings)."
1533
1533
  },
1534
1534
  "sources": [
1535
1535
  {
package/esm2015/lib/modules/flyout/types/flyout-config.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"flyout-config.js","sourceRoot":"","sources":["../../../../../../../../../libs/components/flyout/src/lib/modules/flyout/types/flyout-config.ts"],"names":[],"mappings":"","sourcesContent":["import { SkyFlyoutAction } from './flyout-action';\n\nimport { SkyFlyoutPermalink } from './flyout-permalink';\n\n/**\n * Specifies the configuration options to set up a flyout.\n */\nexport interface SkyFlyoutConfig {\n /**\n * Specifies the HTML element ID (without the leading `#`) of the element that describes\n * the flyout. This sets the flyout's `aria-describedby` attribute\n * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).\n * The description typically includes text on the flyout but not on items that users\n * interact with, such as buttons and forms.\n */\n ariaDescribedBy?: string;\n\n /**\n * Specifies an ARIA label for the flyout. This sets the flyouts's `aria-label` attribute\n * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).\n * If the flyout includes a visible label, use `ariaLabelledBy` instead.\n */\n ariaLabel?: string;\n\n /**\n * Specifies the HTML element ID (without the leading `#`) of the element that labels\n * the flyout. This sets the flyout's `aria-labelledby` attribute\n * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).\n * If the flyout does not include a visible label, use `ariaLabel` instead.\n */\n ariaLabelledBy?: string;\n\n /**\n * Specifies an ARIA role for the flyout\n * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)\n * by indicating how the flyout functions and what it controls. For information about how\n * an ARIA role indicates what an item represents on a web page,\n * see the [WAI-ARIA roles model](https://www.w3.org/WAI/PF/aria/roles).\n * @default dialog\n * @deprecated Since version `5.1.0`. Consumers should use the default `dialog` role to ensure a\n * proper accessibility implementation.\n */\n ariaRole?: string;\n\n /**\n * Specifies the default width of the flyout container. If you do not provide a width,\n * the flyout defaults to half the width of its container.\n */\n defaultWidth?: number;\n\n /**\n * Specifies the minimum resize width of the flyout container.\n * @default 320\n */\n minWidth?: number;\n\n /**\n * Specifies the maximum resize width of the flyout container.\n * @default defaultWidth\n */\n maxWidth?: number;\n\n /**\n * Displays a permalink button in the flyout header that navigates users to the URL\n * (or application route) representative of the flyout's contents.\n */\n permalink?: SkyFlyoutPermalink;\n\n /**\n * Displays a configurable button in the flyout header.\n */\n primaryAction?: SkyFlyoutAction;\n\n /**\n * Specifies an array of custom providers to pass to the component's constructor.\n */\n providers?: any[];\n\n /**\n * Indicates whether to display iterator buttons in the flyout header\n * to access the next and previous records in a record set.\n * @default false\n */\n showIterator?: boolean;\n\n /**\n * Disables the previous iterator button in the flyout header that accesses\n * the previous record in a record set.\n * @default false\n */\n iteratorPreviousButtonDisabled?: boolean;\n\n /**\n * Disables the next iterator button in the flyout header that accesses the next record\n * in a record set.\n * @default false\n */\n iteratorNextButtonDisabled?: boolean;\n\n /**\n * Specifies a unique key for the UI Config Service to retrieve stored settings from a database.\n * The UI Config Service saves configuration settings for users to preserve the width of\n * the flyout. For more information about the UI Config Service,\n * see [the sticky settings documentation](https://developer.blackbaud.com/skyux/learn/get-started/advanced/sticky-settings).\n */\n settingsKey?: string;\n}\n"]}
1
+ {"version":3,"file":"flyout-config.js","sourceRoot":"","sources":["../../../../../../../../../libs/components/flyout/src/lib/modules/flyout/types/flyout-config.ts"],"names":[],"mappings":"","sourcesContent":["import { SkyFlyoutAction } from './flyout-action';\n\nimport { SkyFlyoutPermalink } from './flyout-permalink';\n\n/**\n * Specifies the configuration options to set up a flyout.\n */\nexport interface SkyFlyoutConfig {\n /**\n * Specifies the HTML element ID (without the leading `#`) of the element that describes\n * the flyout. This sets the flyout's `aria-describedby` attribute\n * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).\n * The description typically includes text on the flyout but not on items that users\n * interact with, such as buttons and forms.\n */\n ariaDescribedBy?: string;\n\n /**\n * Specifies an ARIA label for the flyout. This sets the flyouts's `aria-label` attribute\n * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).\n * If the flyout includes a visible label, use `ariaLabelledBy` instead.\n */\n ariaLabel?: string;\n\n /**\n * Specifies the HTML element ID (without the leading `#`) of the element that labels\n * the flyout. This sets the flyout's `aria-labelledby` attribute\n * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).\n * If the flyout does not include a visible label, use `ariaLabel` instead.\n */\n ariaLabelledBy?: string;\n\n /**\n * Specifies an ARIA role for the flyout\n * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)\n * by indicating how the flyout functions and what it controls. For information about how\n * an ARIA role indicates what an item represents on a web page,\n * see the [WAI-ARIA roles model](https://www.w3.org/WAI/PF/aria/roles).\n * @default dialog\n * @deprecated Since version `5.1.0`. Consumers should use the default `dialog` role to ensure a\n * proper accessibility implementation.\n */\n ariaRole?: string;\n\n /**\n * Specifies the default width of the flyout container. If you do not provide a width,\n * the flyout defaults to half the width of its container.\n */\n defaultWidth?: number;\n\n /**\n * Specifies the minimum resize width of the flyout container.\n * @default 320\n */\n minWidth?: number;\n\n /**\n * Specifies the maximum resize width of the flyout container.\n * @default defaultWidth\n */\n maxWidth?: number;\n\n /**\n * Displays a permalink button in the flyout header that navigates users to the URL\n * (or application route) representative of the flyout's contents.\n */\n permalink?: SkyFlyoutPermalink;\n\n /**\n * Displays a configurable button in the flyout header.\n */\n primaryAction?: SkyFlyoutAction;\n\n /**\n * Specifies an array of custom providers to pass to the component's constructor.\n */\n providers?: any[];\n\n /**\n * Indicates whether to display iterator buttons in the flyout header\n * to access the next and previous records in a record set.\n * @default false\n */\n showIterator?: boolean;\n\n /**\n * Disables the previous iterator button in the flyout header that accesses\n * the previous record in a record set.\n * @default false\n */\n iteratorPreviousButtonDisabled?: boolean;\n\n /**\n * Disables the next iterator button in the flyout header that accesses the next record\n * in a record set.\n * @default false\n */\n iteratorNextButtonDisabled?: boolean;\n\n /**\n * Specifies a unique key for the UI Config Service to retrieve stored settings from a database.\n * The UI Config Service saves configuration settings for users to preserve the width of\n * the flyout. For more information about the UI Config Service,\n * see [the sticky settings documentation](https://developer.blackbaud.com/skyux/learn/get-started/sticky-settings).\n */\n settingsKey?: string;\n}\n"]}
package/lib/modules/flyout/types/flyout-config.d.ts CHANGED
@@ -86,7 +86,7 @@ export interface SkyFlyoutConfig {
86
86
  * Specifies a unique key for the UI Config Service to retrieve stored settings from a database.
87
87
  * The UI Config Service saves configuration settings for users to preserve the width of
88
88
  * the flyout. For more information about the UI Config Service,
89
- * see [the sticky settings documentation](https://developer.blackbaud.com/skyux/learn/get-started/advanced/sticky-settings).
89
+ * see [the sticky settings documentation](https://developer.blackbaud.com/skyux/learn/get-started/sticky-settings).
90
90
  */
91
91
  settingsKey?: string;
92
92
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/flyout",
3
- "version": "5.5.0-alpha.0",
3
+ "version": "5.5.0-beta.0",
4
4
  "peerDependencies": {
5
5
  "@angular/animations": "^12.2.16",
6
6
  "@angular/cdk": "^12.2.13",
@@ -8,15 +8,29 @@
8
8
  "@angular/core": "^12.2.16",
9
9
  "@angular/forms": "^12.2.16",
10
10
  "@angular/router": "^12.2.16",
11
- "@skyux/core": "5.5.0-alpha.0",
12
- "@skyux/i18n": "5.5.0-alpha.0",
13
- "@skyux/indicators": "5.5.0-alpha.0",
14
- "@skyux/router": "5.5.0-alpha.0",
15
- "@skyux/theme": "5.5.0-alpha.0"
11
+ "@skyux/core": "5.5.0-beta.0",
12
+ "@skyux/i18n": "5.5.0-beta.0",
13
+ "@skyux/indicators": "5.5.0-beta.0",
14
+ "@skyux/router": "5.5.0-beta.0",
15
+ "@skyux/theme": "5.5.0-beta.0"
16
16
  },
17
17
  "dependencies": {
18
18
  "tslib": "^2.3.1"
19
19
  },
20
+ "author": "Blackbaud, Inc.",
21
+ "keywords": [
22
+ "blackbaud",
23
+ "skyux"
24
+ ],
25
+ "license": "MIT",
26
+ "repository": {
27
+ "type": "git",
28
+ "url": "git+https://github.com/blackbaud/skyux.git"
29
+ },
30
+ "bugs": {
31
+ "url": "https://github.com/blackbaud/skyux/issues"
32
+ },
33
+ "homepage": "https://github.com/blackbaud/skyux#readme",
20
34
  "main": "bundles/skyux-flyout.umd.js",
21
35
  "module": "fesm2015/skyux-flyout.js",
22
36
  "es2015": "fesm2015/skyux-flyout.js",