feat: add timeout method for ui.notification

[weinibuliu]

This PR is based on #4437 , which explores a way to make notifications dismiss after a certain period of time.

This PR provides a method called timeout that allows people to directly override the value of timeout (instead of manually modifying the value of the props)

I did a simple test.It worked well.

# notification.py (This PR did)
class Notification(Element, component='notification.js'):
    ...
    @property
    def timeout(self) -> Optional[float]:
        """The timout value of the notification."""
        return self._props['options']['timeout']

    @timeout.setter
    def timeout(self,value: Optional[float]) -> None:
        self._props["options"]["timeout"] = (value or 0) *1000
        self.update()

# test.py
import asyncio

from nicegui import ui

async def test_set_timeout():
    n = ui.notification("Test Notification",timeout=None)
    n.on_dismiss(lambda:print("Notification Dismiss."))
    await asyncio.sleep(3)
    n.message="Test Done"
    n.timeout = 3 # This is a new method

ui.button("Test").on_click(test_set_timeout)

ui.run()

That's all.

If you have any suggestions for changes to this PR, please let me know. Thanks a lot.

[weinibuliu]

Hi, @falkoschindler
I'm thinking of a method called reset that will allow developers to change almost any value of a notification by calling a single line of code. It will work like below.
Please note that this is just a demo and it is not included in this PR.

# notification.py
class ChangeType(Enum):
    NoneChange = auto() # Make sure people don't provide values ​​that are equal to it

class Notification(Element, component='notification.js'):
    ...
    def reset(self,
              message: Any = ChangeType.NoneChange,
              position: Union[NotificationPosition, ChangeType] = ChangeType.NoneChange,
              type: Union[NotificationType, ChangeType] = ChangeType.NoneChange,
              timeout: Union[float, int, ChangeType] = ChangeType.NoneChange,) -> None: # For a demo,I only use some params.
        
        self.props["options"]["message"] = str(message) if message != ChangeType.NoneChange  else self.props["options"]["message"]
        self.props["options"]["position"] = position if position != ChangeType.NoneChange else self.props["options"]["position"]
        self.props["options"]["type"] = type if type != ChangeType.NoneChange else self.props["options"]["type"]
        self.props["options"]["timeout"] = (timeout or 0)*1000 if timeout != ChangeType.NoneChange else self.props["options"]["timeout"]
        self.update()

Developers only need to call it like this.

# test.py
import asyncio

from nicegui import ui

async def test_reset():
    n = ui.notification("Test Notification",timeout=None,position="bottom-right",type="info")
    n.on_dismiss(lambda:print("Notification Dismiss."))
    await asyncio.sleep(3) # Do something
    n.reset("Test Done",timeout=5,type="positive") # This is a new method

ui.button("Test").on_click(test_reset)

ui.run()

n.reset("Test Done",timeout=5,type="positive")
# It is approximately equivalent to the following code.
n.message = "Test Done"
n.timeout = 5
n.type = "positive"

I think this will be more convenient, can we expand on this? If you have any suggestions for improvements to this idea, please let me know, thank you very much.

[falkoschindler]

Thanks for the pull request, @weinibuliu!
I cleaned it up a bit and now it's ready to merge.

Regarding a reset method: I'm a bit hesitant because we'll basically need to duplicate the signature and docstring of the initializer. But I guess it would be a useful feature nonetheless. Would you like to create a separate pull request?

[weinibuliu]

Thanks for the pull request, @weinibuliu! I cleaned it up a bit and now it's ready to merge.

Regarding a reset method: I'm a bit hesitant because we'll basically need to duplicate the signature and docstring of the initializer. But I guess it would be a useful feature nonetheless. Would you like to create a separate pull request?

Thank you very much for your cleanup and approval.
About reset, should we add it only for the notification component, or for all components? I think it won't be too difficult to add it to all components, but is it necessary for us to do so? If the community feels it is necessary after discussion, I am happy to create a PR.

[weinibuliu]

I have created a new discussion on it. #4460