Skip to content

Add notes for component that has dependency on an optional dependency #1220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 11, 2021
Merged

Add notes for component that has dependency on an optional dependency #1220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/components/card/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ type State = {
* @modifiers: margin, padding
* @gif: https://media.giphy.com/media/l0HU9SKWmv0VTOYMM/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/CardsScreen.tsx
* @notes: 'enableBlur' prop requires installing the '@react-native-community/blur' native library
*/
class Card extends PureComponent<PropTypes, State> {
static displayName = 'Card';
Expand Down
1 change: 1 addition & 0 deletions src/components/connectionStatusBar/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import View from '../view';
* @description: Top bar to show a "no internet" connection status. Note: Run on real device for best results
* @image: https://user-images.githubusercontent.com/33805983/34683190-f3b1904c-f4a9-11e7-9d46-9a340bd35448.png, https://user-images.githubusercontent.com/33805983/34484206-edc6c6e4-efcb-11e7-88b2-cd394c19dd5e.png
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/ConnectionStatusBarScreen.js
* @notes: The component requires installing the '@react-native-community/netinfo' native library
*/
export default class ConnectionStatusBar extends PureBaseComponent {
static displayName = 'ConnectionStatusBar';
Expand Down
1 change: 1 addition & 0 deletions src/components/picker/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ const ItemType = PropTypes.oneOfType([
* @description: Picker Component, support single or multiple selection, blurModel and nativePicker
* @gif: https://media.giphy.com/media/3o751SiuZZiByET2lq/giphy.gif, https://media.giphy.com/media/TgMQnyw5grJIDohzvx/giphy.gif, https://media.giphy.com/media/5hsdmVptBRskZKn787/giphy.gif
* @example: https://github.com/wix/react-native-ui-lib/blob/master/demo/src/screens/componentScreens/PickerScreen.js
* @notes: 'useNativePicker' prop requires installing the '@react-native-picker/picker' native library
*/
class Picker extends Component {
static displayName = 'Picker';
Expand Down
2 changes: 1 addition & 1 deletion uilib-docs/src/templates/component.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export default class ComponentTemplate extends Component {
};

if (component.docblock) {
const infoRaw = _.split(component.docblock, '@');
const infoRaw = _.split(component.docblock, /(^@|\n@)/);
_.forEach(infoRaw, statement => {
const match = splitPattern.exec(statement);
if (statement && match) {
Expand Down