@magento/venia-ui 9.0.0-alpha.2 → 9.0.0-alpha.3

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.
@@ -9,6 +9,13 @@ const removeProps = (props, exclude) => {
9
9
  );
10
10
  };
11
11
 
12
+ /**
13
+ * Use for links to pages within your app.
14
+ *
15
+ * @kind functional component
16
+ * @param {props} props React component props
17
+ * @returns {RouterLink} the `Link` component from `react-router-dom`. We add a `ref` to prefetch pages when the link enters the viewport.
18
+ */
12
19
  const Link = props => {
13
20
  const talonProps = useLink(props);
14
21
  const { ref } = talonProps;
@@ -21,6 +28,9 @@ Link.defaultProps = {
21
28
  prefetchType: false
22
29
  };
23
30
 
31
+ /**
32
+ * @property {bool} [prefetchType=false] Determine if the link should be prefetched using `IntersectionObserver`.
33
+ */
24
34
  Link.propTypes = {
25
35
  prefetchType: bool
26
36
  };
@@ -8,7 +8,6 @@ import logo from './VeniaLogo.svg';
8
8
  /**
9
9
  * A component that renders a logo in the header.
10
10
  *
11
- * @typedef Logo
12
11
  * @kind functional component
13
12
  *
14
13
  * @param {props} props React component props
@@ -35,14 +34,14 @@ const Logo = props => {
35
34
  };
36
35
 
37
36
  /**
38
- * Props for {@link Logo}
37
+ * Props for the Logo component.
39
38
  *
40
- * @typedef props
39
+ * @kind props
41
40
  *
42
- * @property {Object} classes An object containing the class names for the
43
- * Logo component.
44
- * @property {string} classes.logo classes for logo
45
- * @property {number} height the height of the logo.
41
+ * @property {Object} classes An object containing the class names for the Logo component.
42
+ * @property {string} classes.logo Classes for logo
43
+ * @property {number} [height=18] Height of the logo.
44
+ * @property {number} [width=102] Width of the logo.
46
45
  */
47
46
  Logo.propTypes = {
48
47
  classes: PropTypes.shape({
@@ -44,8 +44,6 @@ const Shimmer = props => {
44
44
  };
45
45
 
46
46
  /**
47
- * Props for {@link Shimmer}
48
- *
49
47
  * @typedef props
50
48
  *
51
49
  * @property {Object} classes is an object containing the class names for the
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@magento/venia-ui",
3
- "version": "9.0.0-alpha.2",
3
+ "version": "9.0.0-alpha.3",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -76,8 +76,8 @@
76
76
  "peerDependencies": {
77
77
  "@apollo/client": "~3.1.2",
78
78
  "@magento/babel-preset-peregrine": "~1.1.0",
79
- "@magento/peregrine": "12.0.0-alpha.2",
80
- "@magento/pwa-buildpack": "11.0.0-alpha.2",
79
+ "@magento/peregrine": "12.0.0-alpha.3",
80
+ "@magento/pwa-buildpack": "11.0.0-alpha.3",
81
81
  "apollo-cache-persist": "~0.1.1",
82
82
  "braintree-web-drop-in": "~1.16.0",
83
83
  "graphql": "~15.3.0",