diff --git a/src/components/UserAvatar/UserAvatar.stories.mdx b/src/components/UserAvatar/UserAvatar.stories.mdx index 085e31b..1527c9e 100644 --- a/src/components/UserAvatar/UserAvatar.stories.mdx +++ b/src/components/UserAvatar/UserAvatar.stories.mdx @@ -31,8 +31,24 @@ If the `name` prop is passed, the UserAvatar will display the first letter of th +## With An Alias +If you pass a valid career account username, their corresponding picture will be loaded from ECNDB. + +**Note:** This is a [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) request and will only work when serving the docs from under engineering.purdue.edu. This means the CORS request will fail in development. You can use [this Chrome extension](https://chrome.google.com/webstore/detail/moesif-origin-cors-change/digfbfaphojjndkpccljibejjbppifbc) or similar to temporarily disable CORS protections. + + + + { args => } + + + ## Forwarded Props -All props other than `name` are passed to the underlying [MUI Avatar component](https://material-ui.com/api/avatar/). +All props not listed in the table below are passed to the underlying [MUI Avatar component](https://material-ui.com/api/avatar/).