github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2025-04-05 02:46:55 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add 10 seconds delay before showing grammarly warning

Browse source 
GitOrigin-RevId: 11bb3ca5704ef5cc782d14eb6f4f10a1fa2a656e
This commit is contained in:
M Fahru 2022-11-24 10:50:43 -05:00 committed by Copybot
parent 6dcc22642a
commit 31c503be2d
4 changed files with 36 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
services/web/app/views/project/editor.pug
View file

@ -65,7 +65,7 @@ block content
span.sr-only #{translate("close")}
.system-message-content(ng-bind-html="htmlContent")
grammarly-warning()
grammarly-warning(delay=10000)
include ./editor/main

30
services/web/frontend/js/features/source-editor/components/grammarly-warning.tsx
View file

@ -1,11 +1,16 @@
import { useCallback, useEffect, useState } from 'react'
import { Button } from 'react-bootstrap'
import { Nullable } from '../../../../../types/utils'
import customLocalStorage from '../../../infrastructure/local-storage'
import useScopeValue from '../../../shared/hooks/use-scope-value'
import grammarlyExtensionPresent from '../../../shared/utils/grammarly'
import getMeta from '../../../utils/meta'
export default function GrammarlyWarning() {
type GrammarlyWarningProps = {
delay: number
}
export default function GrammarlyWarning({ delay }: GrammarlyWarningProps) {
const [show, setShow] = useState(false)
const [newSourceEditor] = useScopeValue('editor.newSourceEditor')
const [showRichText] = useScopeValue('editor.showRichText')
@ -21,10 +26,29 @@ export default function GrammarlyWarning() {
newSourceEditor &&
!showRichText
let timeoutID: Nullable<number>
if (showGrammarlyWarning) {
setShow(true)
const timeout = window.setTimeout(() => {
setShow(true)
timeoutID = null
}, delay)
timeoutID = timeout
}
}, [grammarly, hasDismissedGrammarlyWarning, newSourceEditor, showRichText])
return () => {
if (timeoutID) {
clearTimeout(timeoutID)
}
}
}, [
grammarly,
hasDismissedGrammarlyWarning,
newSourceEditor,
showRichText,
delay,
])
const handleClose = useCallback(() => {
setShow(false)

2
services/web/frontend/js/features/source-editor/controllers/grammarly-warning-controller.js
View file

@ -5,5 +5,5 @@ import GrammarlyWarning from '../components/grammarly-warning'
App.component(
'grammarlyWarning',
react2angular(rootContext.use(GrammarlyWarning))
react2angular(rootContext.use(GrammarlyWarning), ['delay'])
)

14
services/web/test/frontend/features/source-editor/components/grammarly-warning.test.js
View file

@ -29,7 +29,7 @@ describe('<GrammarlyWarning />', function () {
grammarlyStub.returns(true)
window.metaAttributesCache.set('ol-showNewSourceEditorOption', true)
renderWithEditorContext(<GrammarlyWarning />, {
renderWithEditorContext(<GrammarlyWarning delay={100} />, {
scope: {
editor: {
newSourceEditor: true,
@ -48,7 +48,7 @@ describe('<GrammarlyWarning />', function () {
grammarlyStub.returns(false)
window.metaAttributesCache.set('ol-showNewSourceEditorOption', true)
renderWithEditorContext(<GrammarlyWarning />, {
renderWithEditorContext(<GrammarlyWarning delay={100} />, {
scope: {
editor: {
newSourceEditor: true,
@ -70,7 +70,7 @@ describe('<GrammarlyWarning />', function () {
localStorage.setItem('editor.has_dismissed_grammarly_warning', true)
window.metaAttributesCache.set('ol-showNewSourceEditorOption', true)
renderWithEditorContext(<GrammarlyWarning />, {
renderWithEditorContext(<GrammarlyWarning delay={100} />, {
scope: {
editor: {
newSourceEditor: true,
@ -91,7 +91,7 @@ describe('<GrammarlyWarning />', function () {
grammarlyStub.returns(true)
window.metaAttributesCache.set('ol-showNewSourceEditorOption', false)
renderWithEditorContext(<GrammarlyWarning />)
renderWithEditorContext(<GrammarlyWarning delay={100} />)
await waitFor(() => {
expect(
@ -106,7 +106,7 @@ describe('<GrammarlyWarning />', function () {
grammarlyStub.returns(true)
window.metaAttributesCache.set('ol-showNewSourceEditorOption', true)
renderWithEditorContext(<GrammarlyWarning />, {
renderWithEditorContext(<GrammarlyWarning delay={100} />, {
scope: {
editor: {
newSourceEditor: false,
@ -127,7 +127,7 @@ describe('<GrammarlyWarning />', function () {
grammarlyStub.returns(true)
window.metaAttributesCache.set('ol-showNewSourceEditorOption', true)
renderWithEditorContext(<GrammarlyWarning />, {
renderWithEditorContext(<GrammarlyWarning delay={100} />, {
scope: {
editor: {
newSourceEditor: true,
@ -149,7 +149,7 @@ describe('<GrammarlyWarning />', function () {
grammarlyStub.returns(true)
window.metaAttributesCache.set('ol-showNewSourceEditorOption', true)
renderWithEditorContext(<GrammarlyWarning />, {
renderWithEditorContext(<GrammarlyWarning delay={100} />, {
scope: {
editor: {
newSourceEditor: true,