Skip to content

Commit 2689320

Browse files
Fixing doc synthax highlighting + typo HoverReactionsBar
1 parent 165bd98 commit 2689320

File tree

3 files changed

+32
-30
lines changed

3 files changed

+32
-30
lines changed

docs/documentation/docs/controls/HoverReactionsBar.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,27 @@ import { HoverReactionsBar } from '@pnp/spfx-controls-react/lib/HoverReactionsBa
3737
- With the `onSelect` property you can get the selected emoji:
3838

3939
```typescript
40-
const onSelectEmoji = React.useCallback(async (emoji: string, emojiInfo: IEmojiInfo) => {
41-
console.log('emoji', emoji);
42-
console.log('emojiInfo object',emojiInfo);
43-
setIsOpenHoverReactionBar(false);
44-
}, []);
40+
const onSelectEmoji = React.useCallback(async (emoji: string, emojiInfo: IEmojiInfo) => {
41+
console.log('emoji', emoji);
42+
console.log('emojiInfo object',emojiInfo);
43+
setIsOpenHoverReactionBar(false);
44+
}, []);
4545

46-
```
4746
onSelect: (emoji: string | undefined, emojiInfo?: IEmojiInfo) => void;
4847
isOpen: boolean;
4948
onDismiss: () => void;
5049
top4Reactions?: string[];
5150
target: HTMLDivElement;
5251
themeV8?: Theme ;
52+
```
5353

5454
## Implementation
5555

5656
The HoverReactionsBar control can be configured with the following properties:
5757

5858
| Property | Type | Required | Description |
5959
| ---- | ---- | ---- | ---- |
60-
| isOpen | boolean | yes | show hoverReactionsVar |
60+
| isOpen | boolean | yes | show hoverReactionsBar |
6161
| onSelected |onSelect: (emoji: string, emojiInfo?: IEmojiInfo) => void;| yes | selected Emoji |
6262
| top4Reactions | string[] | no | name of emojis to show on the bar |
6363
| target | HTMLDivElement | yes | container of controls who fire the HoverReactionsBar |

docs/documentation/docs/guides/contributing.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,23 @@ Typos are embarrassing! Most PR's that fix typos will be accepted immediately. I
2727
Before contributing:
2828

2929
- ensure that the **dev** branch on your fork is in sync with the original **sp-dev-fx-controls-react** repository
30-
```bash
31-
# assuming you are in the folder of your locally cloned fork....
32-
git checkout dev
3330

34-
# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-controls-react** repo
35-
git fetch upstream
31+
```bash
32+
# assuming you are in the folder of your locally cloned fork....
33+
git checkout dev
3634

37-
# update your local dev to be a mirror of what's in the main repo
38-
git pull --rebase upstream dev
39-
```
35+
# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-controls-react** repo
36+
git fetch upstream
37+
38+
# update your local dev to be a mirror of what's in the main repo
39+
git pull --rebase upstream dev
40+
```
4041

4142
- create a feature branch for your change. If you'll get stuck on an issue or merging your PR will take a while, this will allow you to have a clean dev branch that you can use for contributing other changes
4243

43-
```bash
44-
git checkout -b my-contribution
45-
```
44+
```bash
45+
git checkout -b my-contribution
46+
```
4647

4748
## DO's & DON'Ts
4849

docs/documentation/docs/guides/submitting-pr.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,23 @@ We appreciate your initiative and would love to integrate your work with the res
77
- [AC: Keep Your Forked Git Repo Updated with Changes from the Original Upstream Repo](http://www.andrewconnell.com/blog/keep-your-forked-git-repo-updated-with-changes-from-the-original-upstream-repo)
88
- Looking for a quick cheat sheet? Look no further:
99

10-
```bash
11-
# assuming you are in the folder of your locally cloned fork....
12-
git checkout dev
10+
```bash
11+
# assuming you are in the folder of your locally cloned fork....
12+
git checkout dev
1313

14-
# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-controls-react** repo
15-
git fetch upstream
14+
# assuming you have a remote named `upstream` pointing to the official **sp-dev-fx-controls-react** repo
15+
git fetch upstream
1616

17-
# update your local dev branch to be a mirror of what's in the main repo
18-
git pull --rebase upstream dev
17+
# update your local dev branch to be a mirror of what's in the main repo
18+
git pull --rebase upstream dev
1919

20-
# switch to your branch where you are working, say "issue-xyz"
21-
git checkout issue-xyz
20+
# switch to your branch where you are working, say "issue-xyz"
21+
git checkout issue-xyz
22+
23+
# update your branch to update its fork point to the current tip of dev & put your changes on top of it
24+
git rebase dev
25+
```
2226

23-
# update your branch to update its fork point to the current tip of dev & put your changes on top of it
24-
git rebase dev
25-
```
2627
- submit PR to the **dev** branch of the main repo. PRs submitted to other branches will be declined
2728
- let us know what's in the PR: is it a new command, bug fix or a minor update in the docs? The clearer the information you provide, the quicker your PR can be verified and merged
2829
- ideally 1 PR = 1 commit - this makes it easier to keep the log clear for everyone and track what's changed. If you're new to working with git, we'll squash your commits for you when merging your changes into the main repo

0 commit comments

Comments
 (0)