Skip to content

Commit e859b27

Browse files
author
Dennis Suitters
authored
Merge pull request #58 from DiemenDesign/master
Add Explanation for isFullscreen.
2 parents edfab7b + 2c292c8 commit e859b27

File tree

1 file changed

+40
-33
lines changed

1 file changed

+40
-33
lines changed

01-deep-dive.md

Lines changed: 40 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,13 @@ You can toggle Fullscreen view by API.
366366
$('#summernote').summernote('fullscreen.toggle');
367367
{% endhighlight %}
368368

369+
### isFullscreen
370+
You can programmatically determine if the Summernote is in Fullscreen mode by using `isFullscreen`, which will return `true` or `false`.
371+
{% highlight javascript %}
372+
$('#summernote').summernote('fullscreen.isFullscreen');
373+
{% endhighlight %}
374+
375+
369376
### interface
370377
You can find programmatically which Summernote you are using.
371378
This will return one of three values: `bs3`, `bs4` or `lite`.
@@ -609,80 +616,80 @@ refer to [#saveRange](#saverange-restorerange)
609616
### restoreRange
610617
refer to [#restorerange](#saverange-restorerange)
611618

612-
### getLastRange
613-
summernote is saving a range object(WrappedRange) on current cursor.
619+
### getLastRange
620+
summernote is saving a range object(WrappedRange) on current cursor.
614621

615622
{% highlight javascript %}
616623
const rng = $('#summernote').summernote('editor.getLastRange');
617624
{% endhighlight %}
618625

619-
> #### when summernote save a range with dom event
626+
> #### when summernote save a range with dom event
620627
> * keydown
621628
> * keyup
622629
> * focus
623630
> * mouseup
624-
> * paste
631+
> * paste
625632
626-
> #### when summernote save a range with api
627-
> * `editor.insertImage` -> Image
628-
> * `editor.insertNode` -> Node
633+
> #### when summernote save a range with api
634+
> * `editor.insertImage` -> Image
635+
> * `editor.insertNode` -> Node
629636
> * `editor.insertText` -> TextNode
630-
> * `editor.pasteHTML` -> last Node of contents
631-
> * `editor.insertHorizontalRule` -> next sibling node of hr node
632-
> * `editor.createLink` -> link node
637+
> * `editor.pasteHTML` -> last Node of contents
638+
> * `editor.insertHorizontalRule` -> next sibling node of hr node
639+
> * `editor.createLink` -> link node
633640
634-
### setLastRange
641+
### setLastRange
635642

636643
You can define custom range in node of summernote editable element.
637644

638645
{% highlight javascript %}
639-
const range = $.summernote.range; // range utility
640-
// set my custom range
646+
const range = $.summernote.range; // range utility
647+
// set my custom range
641648
$('#summernote').summernote('editor.setLastRange', range.createFromNodeAfter(node).select());
642649
{% endhighlight %}
643650

644-
### `range` utility
651+
### `range` utility
645652

646653
{% highlight javascript %}
647-
const range = $.summernote.range; // range utility
654+
const range = $.summernote.range; // range utility
648655
{% endhighlight %}
649656

650657

651658
#### create WrappedRange Object
652659

653660
range utility make a WrappedRange Class's instance
654661

655-
##### create
662+
##### create
656663

657664
create WrappedRange Object From arguments or Browser Selection
658665

659666
{% highlight javascript %}
660667
const rng = range.create(startContainer, startOffset, endContainer, endOffset)
661668

662-
// or
669+
// or
663670

664671
const rng = range.create() // is equals range.createFromSelection()
665672

666673
{% endhighlight %}
667674

668675

669-
##### createFromNode
676+
##### createFromNode
670677

671678
create WrappedRange object from node
672679

673680
{% highlight javascript %}
674681
const rng = range.createFromNode(node)
675682
{% endhighlight %}
676683

677-
##### createFromNodeBefore
684+
##### createFromNodeBefore
678685

679686
create WrappedRange from node before position
680687

681688
{% highlight javascript %}
682689
const rng = range.createFromNodeBefore(node)
683690
{% endhighlight %}
684691

685-
##### createFromNodeAfter
692+
##### createFromNodeAfter
686693

687694
create WrappedRange from node after position
688695

@@ -691,7 +698,7 @@ const rng = range.createFromNodeAfter(node)
691698
{% endhighlight %}
692699

693700

694-
##### createFromSelection
701+
##### createFromSelection
695702

696703
create WrappedRange object from selection
697704

@@ -702,25 +709,25 @@ const rng = range.createFromSelection(node)
702709

703710
#### WrappedRange Object
704711

705-
##### select()
712+
##### select()
706713

707714
select update visible range
708715

709716
```
710717
rng.select()
711718
```
712719

713-
##### collapse(isCollapseToStart)
720+
##### collapse(isCollapseToStart)
714721

715722
```
716723
const newRng = rng.collapse(true); // to start rng
717724
718-
or
725+
or
719726
720-
const newRng = rng.collapse(); // to end rng
727+
const newRng = rng.collapse(); // to end rng
721728
```
722729

723-
##### splitText()
730+
##### splitText()
724731

725732
splitText on range
726733

@@ -729,7 +736,7 @@ const textRng = rng.splitText()
729736
```
730737

731738

732-
##### deleteContents()
739+
##### deleteContents()
733740

734741
delete contents on range
735742

@@ -738,7 +745,7 @@ const newRng = rng.deleteContents()
738745
```
739746

740747

741-
##### isCollapsed()
748+
##### isCollapsed()
742749

743750
returns whether range was collapsed or not
744751

@@ -783,14 +790,14 @@ returns text in range
783790
returns range for word before(or after) cursor
784791

785792
```
786-
const newRng = rng.getWordRange(); // before cursor
793+
const newRng = rng.getWordRange(); // before cursor
787794
788-
// or
795+
// or
789796
790-
const newRng = rng.getWordRange(true); // after cursor
797+
const newRng = rng.getWordRange(true); // after cursor
791798
```
792799

793-
##### getWordsMatchRange(regex)
800+
##### getWordsMatchRange(regex)
794801

795802
returns range for words before cursor that match with a Regex
796803

@@ -800,7 +807,7 @@ const rng = range.create() // or $('.summernote').summernote('getLastRange');
800807
801808
const newRng = rng.getWordsMatchRange(/@[a-z ]+/i)
802809
803-
console.log(newRng.toString()) // '@Peter Pan'
810+
console.log(newRng.toString()) // '@Peter Pan'
804811
```
805812

806813

0 commit comments

Comments
 (0)